ro.sync.contentcompletion.xml

Class WhatPossibleValuesHasAttributeContext

java.lang.Object

ro.sync.contentcompletion.xml.Context

ro.sync.contentcompletion.xml.WhatContextInParent

ro.sync.contentcompletion.xml.WhatPossibleValuesHasAttributeContext

All Implemented Interfaces:

java.lang.Cloneable

@API(type=EXTENDABLE,
     src=PRIVATE)
public class WhatPossibleValuesHasAttributeContext
extends ro.sync.contentcompletion.xml.WhatContextInParent

It is used to determine the possible values of the current attribute.

Field Summary

Fields inherited from class ro.sync.contentcompletion.xml.WhatContextInParent

parentElement

Fields inherited from class ro.sync.contentcompletion.xml.Context

elementStack, idValuesList, infoProvider, nextSiblingElements, prefixNamespaceMapping, previousSiblingElements, xmlReader

Constructor Summary

Constructors

Constructor and Description
WhatPossibleValuesHasAttributeContext()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
java.util.List<java.lang.String>	getAncestorValues(java.lang.String name, java.lang.String namespace, java.lang.String attribute) Get the values of the specified (by name) attribute from the ancestors with the given name and namespace.
java.lang.String	getAttributeName() Gets the name of the attribute, including the namespace prefix, if any.
java.lang.String	getCurrentValueBeforeCaret() Get the existing attribute value before the caret position.
java.lang.String	getCurrentValuePrefix() Get the already inserted value prefix.
java.lang.String	getDefaultAttributeValue()
Attribute[]	getGrandparentAttributes() Get the grandparent's attributes.
java.lang.String	getGrandparentElement() Get the qualified name of the grand parent element.
java.lang.String	getGrandparentNamespace() Get the namespace of the grand parent element.
void	setAttributeName(java.lang.String attributeName) Sets the attribute name, including the namespace prefix, if any.
void	setCurrentValueBeforeCaret(java.lang.String currentValueBeforeCaret) Set the current attribute value before the caret position.
void	setCurrentValuePrefix(java.lang.String currentValuePrefix) Set the the already inserted value prefix.
java.lang.String	toString() Get a description of the current context.

Methods inherited from class ro.sync.contentcompletion.xml.WhatContextInParent

getParentElement, getPreviousAttributeNames, getPreviousAttributes, getPreviousAttributesList, getRootAttributes, pushContextElement, setParentElement

Methods inherited from class ro.sync.contentcompletion.xml.Context

executeXPath, executeXPath, getDefaultAttributeValue, getElementStack, getIdValuesList, getNextSiblingElements, getPrefixNamespaceMapping, getPreviousSiblingElements, getSystemID, setAdditionalContextInformationProvider, setElementStack, setIdValuesList, setNextSiblingElements, setPrefixNamespaceMapping, setPreviousSiblingElements, setXMLReader

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WhatPossibleValuesHasAttributeContext

public WhatPossibleValuesHasAttributeContext()

Method Detail

getAttributeName

public java.lang.String getAttributeName()

Gets the name of the attribute, including the namespace prefix, if any.

Returns:

The attribute name.

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Sets the attribute name, including the namespace prefix, if any.

Parameters:

attributeName - The attribute name.

toString

public java.lang.String toString()

Get a description of the current context.

Overrides:

toString in class java.lang.Object

Returns:

A string containing information about the current context: attribute name, parent element qualified name, parent element type, element stack.

getGrandparentAttributes

public Attribute[] getGrandparentAttributes()

Get the grandparent's attributes.

Returns:

The grandparent attributes.

getGrandparentElement

public java.lang.String getGrandparentElement()

Get the qualified name of the grand parent element.

Returns:

The name of the attribute grandparent element.

Throws:

java.util.EmptyStackException - In case the stack is empty.

getGrandparentNamespace

public java.lang.String getGrandparentNamespace()

Get the namespace of the grand parent element.

Returns:

The element namespace for the element that is the grandparent of the current attribute.

Throws:

java.util.EmptyStackException - In case the stack is empty.

getAncestorValues

public java.util.List<java.lang.String> getAncestorValues(java.lang.String name,
                                                 java.lang.String namespace,
                                                 java.lang.String attribute)

Get the values of the specified (by name) attribute from the ancestors with the given name and namespace.

Parameters:

name - The name of the element where the attribute must be searched.

namespace - The namespace of the element where the attribute must be searched.

attribute - The attribute local name.

Returns:

A list of attribute values, never null.

getCurrentValuePrefix

public java.lang.String getCurrentValuePrefix()

Get the already inserted value prefix.

Returns:

The text from the start position of the attribute value and the caret position. Can be null if no prefix was found.

setCurrentValuePrefix

public void setCurrentValuePrefix(java.lang.String currentValuePrefix)

Set the the already inserted value prefix.

Parameters:

currentValuePrefix - The text from the start position of the attribute value and the caret position.

getCurrentValueBeforeCaret

public java.lang.String getCurrentValueBeforeCaret()

Get the existing attribute value before the caret position.

Returns:

Returns the current attribute value before caret.

setCurrentValueBeforeCaret

public void setCurrentValueBeforeCaret(java.lang.String currentValueBeforeCaret)

Set the current attribute value before the caret position.

Parameters:

currentValueBeforeCaret - The current attribute value before the caret position to be set.

clone

public java.lang.Object clone()

Overrides:

clone in class ro.sync.contentcompletion.xml.WhatContextInParent

See Also:

WhatContextInParent.clone()

getDefaultAttributeValue

public java.lang.String getDefaultAttributeValue()

Returns:

The default value of the attribute in the associated schema.