ro.sync.contentcompletion.xml
Class CIElementAdapter

java.lang.Object
  ro.sync.contentcompletion.xml.CIElementAdapter

All Implemented Interfaces:

java.lang.Comparable<CIElement>, CIElement, NodeDescription

public class CIElementAdapter
extends java.lang.Object
implements CIElement

A CIElement adapter. Simplifies the implementation.

Field Summary

Fields inherited from interface ro.sync.contentcompletion.xml.CIElement

CONTENT_TYPE_ELEMENT_ONLY, CONTENT_TYPE_EMPTY, CONTENT_TYPE_MIXED, CONTENT_TYPE_NOT_DETERMINED

Constructor Summary

CIElementAdapter()

Method Summary

void	addGuessElement(CIElement childElement) Add a child element to the list of element's children.
int	compareTo(CIElement o)
java.lang.String	getAnnotation()
java.util.List<CIAttribute>	getAttributes() Returns the list with the element attributes.
int	getContentType() Get the content type of the element.
java.lang.String	getFacetFractionDigitsValue() Get the value of the FRACTION_DIGITS facet, can be null if it is not defined.
java.lang.String	getFacetLengthValue() Get the value of the LENGTH facet, can be null if it is not defined.
java.lang.String	getFacetMaxExclusiveValue() Get the value of the MAX_EXCLUSIVE facet, can be null if it is not defined.
java.lang.String	getFacetMaxInclusiveValue() Get the value of the MAX_INCLUSIVE facet, can be null if it is not defined.
java.lang.String	getFacetMaxLengthValue() Get the value of the MAX LENGTH facet, can be null if it is not defined.
java.lang.String	getFacetMinExclusiveValue() Get the value of the MIN_EXCLUSIVE facet, can be null if it is not defined.
java.lang.String	getFacetMinInclusiveValue() Get the value of the MIN_INCLUSIVE facet, can be null if it is not defined.
java.lang.String	getFacetMinLengthValue() Get the value of the MIN LENGTH facet, can be null if it is not defined.
java.lang.String	getFacetPattern() Get the value of the PATTERN facets as String, can be null if is not defined.
java.lang.String	getFacetTotalDigitsValue() Get the value of the TOTAL_DIGITS facet, can be null if it is not defined.
java.lang.String	getFacetWhitespaceValue() Get the value of the WHITESPACE facet, can be null if it is not defined.
java.util.List<CIElement>	getGuessElements() Get the list with the children elements of the current element.
java.lang.String	getModelDescription() Get the model description.
java.lang.String	getName() Get the node(attribute or element) name.
java.lang.String	getNamespace()
java.util.List<java.lang.String>	getPossibleValues() Get the possible values as a list of String values.
java.lang.String	getPrefix()
java.lang.String	getQName() Returns the qualified name of the element.
java.lang.String	getTypeDescription() Gets the type description for the element.
boolean	hasPrefix()
boolean	isDeclareXmlns()
boolean	isEmpty() true if the element is empty because it has empty content type or the element type is nillable.
boolean	isNillable()
void	setAnnotation(java.lang.String annotation) Sets the annotation for the element.
void	setAttributes(java.util.List<CIAttribute> attributes) Sets the list with the element attributes.
void	setContentType(int contentType) Sets the content type of the element.
void	setDeclareXmlns(boolean declareXmlns) Sets the value of the flag indicating if the xmlns declaration must be added for the element.
void	setFacetFractionDigitsValue(java.lang.String fractionDigitsFacetValue) Set the value of the FRACTION_DIGITS facet.
void	setFacetLengthValue(java.lang.String lengthFacetValue) Set the value of the LENGTH facet.
void	setFacetMaxExclusiveValue(java.lang.String maxExclusiveFacetValue) Set the value of the MAX_EXCLUSIVE facet.
void	setFacetMaxInclusiveValue(java.lang.String maxInclusiveFacetValue) Set the value of the MAX_INCLUSIVE facet.
void	setFacetMaxLengthValue(java.lang.String maxLengthFacetValue) Set the value of the MAX_LENGTH facet.
void	setFacetMinExclusiveValue(java.lang.String minExclusiveFacetValue) Set the value of the MIN_EXCLUSIVE facet.
void	setFacetMinInclusiveValue(java.lang.String minInclusiveFacetValue) Set the value of the MIN_INCLUSIVE facet.
void	setFacetMinLengthValue(java.lang.String minLengthFacetValue) Set the value of the MIN_LENGTH facet.
void	setFacetPattern(java.lang.String patternFacets) Set the value of the PATTERN facets.
void	setFacetTotalDigitsValue(java.lang.String totalDigitsFacetValue) Set the value of the TOTAL_DIGITS facet.
void	setFacetWhitespaceValue(java.lang.String whitespaceFacetValue) Set the value of the WHITESPACE facet.
void	setModelDescription(java.lang.String modelDescription) Set the model description for the node.
void	setName(java.lang.String name) Set the name of the element.
void	setNamespace(java.lang.String namespace) Set the namespace URI for the element.
void	setNillable(boolean nillable) Sets the flag representing the value of the nillable attribute of element.
void	setPossiblesValues(java.util.List<java.lang.String> possiblesValues) Set the list of possible values for the node.
void	setPrefix(java.lang.String prefix) Set the prefix associated with the element namespace.
void	setTypeDescription(java.lang.String typeDescription) Sets the type description for the current element

Methods inherited from class java.lang.Object

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

Constructor Detail

CIElementAdapter

public CIElementAdapter()

Method Detail

addGuessElement

public void addGuessElement(CIElement childElement)

Description copied from interface: CIElement

Add a child element to the list of element's children. When the current CIElement is chosen from the list of proposed elements (e.g. the list of proposals from the Content Completion window), the children elements are also inserted.
For example if person is the current CIElement, and the list of children contains the elements name and address, the result of choosing the person entry from the Content Completion window will be the insertion of the following sequence:

 <person>
     <name>...</name>
     <address>...</address>
 </person>
 

This method can be used in the SchemaManagerFilter.filterElements(List, WhatElementsCanGoHereContext) method to add new children to the CIElements proposed by the original SchemaManager.

Specified by:

addGuessElement in interface CIElement

Parameters:

childElement - The CIElement element to be added as child.

See Also:

CIElement.addGuessElement(ro.sync.contentcompletion.xml.CIElement)

getAttributes

public java.util.List<CIAttribute> getAttributes()

Description copied from interface: CIElement

Returns the list with the element attributes.

Specified by:

getAttributes in interface CIElement

Returns:

The list with CIAttribute or null if the element has no attributes.

See Also:

CIElement.getAttributes()

getContentType

public int getContentType()

Description copied from interface: CIElement

Get the content type of the element.

Specified by:

getContentType in interface CIElement

Returns:

The content type of the element. Can be one of the constants: CIElement.CONTENT_TYPE_ELEMENT_ONLY, CIElement.CONTENT_TYPE_EMPTY, CIElement.CONTENT_TYPE_MIXED, CIElement.CONTENT_TYPE_NOT_DETERMINED.

See Also:

CIElement.getContentType()

getGuessElements

public java.util.List<CIElement> getGuessElements()

Description copied from interface: CIElement

Get the list with the children elements of the current element. When the current CIElement is chosen from the list of proposed elements (e.g. the list of proposals from the Content Completion window), the children elements are also inserted in the document.
For example if person is the current CIElement, and the list of children contains the elements name and address, the result of choosing the person entry from the Content Completion window will be the insertion of the following sequence:

 <person>
     <name>...</name>
     <address>...</address>
 </person>
 

This method can be implemented by the CIElements returned by the SchemaManagerFilter.filterElements(List, WhatElementsCanGoHereContext) method in order to return a customized list of children, thus modifying the original list proposed by the SchemaManager.

Specified by:

getGuessElements in interface CIElement

Returns:

A list of CIElement objects, or null if the element accepts no children.

See Also:

CIElement.getGuessElements()

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface CIElement

Returns:

The namespace URI of the element string or null if the element has no namespace.

See Also:

CIElement.getNamespace()

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface CIElement

Returns:

The namespace prefix or null if the element has no prefix set.

See Also:

CIElement.getPrefix()

getQName

public java.lang.String getQName()

Description copied from interface: CIElement

Returns the qualified name of the element. It is obtained from the namespace prefix and the local name.

Specified by:

getQName in interface CIElement

Returns:

The qualified name of the element or null if the local name and prefix are null.

See Also:

CIElement.getQName()

getTypeDescription

public java.lang.String getTypeDescription()

Description copied from interface: CIElement

Gets the type description for the element.

Specified by:

getTypeDescription in interface CIElement

Returns:

A String description of the element type.

See Also:

CIElement.getTypeDescription()

hasPrefix

public boolean hasPrefix()

Specified by:

hasPrefix in interface CIElement

Returns:

true if a namespace prefix was previously set.

See Also:

CIElement.hasPrefix()

isDeclareXmlns

public boolean isDeclareXmlns()

Specified by:

isDeclareXmlns in interface CIElement

Returns:

true if the element has an xmlns declaration.

See Also:

CIElement.isDeclareXmlns()

isEmpty

public boolean isEmpty()

Description copied from interface: CIElement

true if the element is empty because it has empty content type or the element type is nillable.

Specified by:

isEmpty in interface CIElement

Returns:

true if empty content type or nillable content.

See Also:

CIElement.isEmpty()

isNillable

public boolean isNillable()

Specified by:

isNillable in interface CIElement

Returns:

true if the content of the element is nillable. Used only for XML Schema elements.

See Also:

CIElement.isNillable()

setAnnotation

public void setAnnotation(java.lang.String annotation)

Description copied from interface: CIElement

Sets the annotation for the element.

Specified by:

setAnnotation in interface CIElement

Parameters:

annotation - A text annotation for the element, or null.

See Also:

CIElement.setAnnotation(java.lang.String)

setAttributes

public void setAttributes(java.util.List<CIAttribute> attributes)

Description copied from interface: CIElement

Sets the list with the element attributes.

Specified by:

setAttributes in interface CIElement

Parameters:

attributes - The list of CIAttribute to be set.

See Also:

CIElement.setAttributes(java.util.List)

setContentType

public void setContentType(int contentType)

Description copied from interface: CIElement

Sets the content type of the element.

Specified by:

setContentType in interface CIElement

Parameters:

contentType - The content type of the element. It can be one of the constants: CIElement.CONTENT_TYPE_ELEMENT_ONLY, CIElement.CONTENT_TYPE_EMPTY, CIElement.CONTENT_TYPE_MIXED, CIElement.CONTENT_TYPE_NOT_DETERMINED.

See Also:

CIElement.setContentType(int)

setDeclareXmlns

public void setDeclareXmlns(boolean declareXmlns)

Description copied from interface: CIElement

Sets the value of the flag indicating if the xmlns declaration must be added for the element.

Specified by:

setDeclareXmlns in interface CIElement

Parameters:

declareXmlns - true if the namespace must be declared.

See Also:

CIElement.setDeclareXmlns(boolean)

setName

public void setName(java.lang.String name)

Description copied from interface: CIElement

Set the name of the element.

Specified by:

setName in interface CIElement

Parameters:

name - the name of the element.

See Also:

CIElement.setName(java.lang.String)

setNamespace

public void setNamespace(java.lang.String namespace)

Description copied from interface: CIElement

Set the namespace URI for the element.

Specified by:

setNamespace in interface CIElement

Parameters:

namespace - The namespace URI to be set.

See Also:

CIElement.setNamespace(java.lang.String)

setNillable

public void setNillable(boolean nillable)

Description copied from interface: CIElement

Sets the flag representing the value of the nillable attribute of element. Used only for elements defined in an XML Schema.

Specified by:

setNillable in interface CIElement

Parameters:

nillable - true if the content of the element defined in the XML Schema is nillable.

See Also:

CIElement.setNillable(boolean)

setPrefix

public void setPrefix(java.lang.String prefix)

Description copied from interface: CIElement

Set the prefix associated with the element namespace.

Specified by:

setPrefix in interface CIElement

Parameters:

prefix - The namespace prefix to be set.

See Also:

CIElement.setPrefix(java.lang.String)

setTypeDescription

public void setTypeDescription(java.lang.String typeDescription)

Description copied from interface: CIElement

Sets the type description for the current element

Specified by:

setTypeDescription in interface CIElement

Parameters:

typeDescription - The String representing the type description.

See Also:

CIElement.setTypeDescription(java.lang.String)

compareTo

public int compareTo(CIElement o)

Specified by:

compareTo in interface java.lang.Comparable<CIElement>

See Also:

Comparable.compareTo(java.lang.Object)

getAnnotation

public java.lang.String getAnnotation()

Specified by:

getAnnotation in interface NodeDescription

Returns:

The node annotation, can be null.

See Also:

NodeDescription.getAnnotation()

getFacetFractionDigitsValue

public java.lang.String getFacetFractionDigitsValue()

Description copied from interface: NodeDescription

Get the value of the FRACTION_DIGITS facet, can be null if it is not defined.

Specified by:

getFacetFractionDigitsValue in interface NodeDescription

Returns:

The value of the FRACTION_DIGITS facet.

See Also:

NodeDescription.getFacetFractionDigitsValue()

getFacetLengthValue

public java.lang.String getFacetLengthValue()

Description copied from interface: NodeDescription

Get the value of the LENGTH facet, can be null if it is not defined.

Specified by:

getFacetLengthValue in interface NodeDescription

Returns:

The value of the LENGTH facet.

See Also:

NodeDescription.getFacetLengthValue()

getFacetMaxExclusiveValue

public java.lang.String getFacetMaxExclusiveValue()

Description copied from interface: NodeDescription

Get the value of the MAX_EXCLUSIVE facet, can be null if it is not defined.

Specified by:

getFacetMaxExclusiveValue in interface NodeDescription

Returns:

The value of the MAX_EXCLUSIVE facet.

See Also:

NodeDescription.getFacetMaxExclusiveValue()

getFacetMaxInclusiveValue

public java.lang.String getFacetMaxInclusiveValue()

Description copied from interface: NodeDescription

Get the value of the MAX_INCLUSIVE facet, can be null if it is not defined.

Specified by:

getFacetMaxInclusiveValue in interface NodeDescription

Returns:

The value of the MAX_INCLUSIVE facet.

See Also:

NodeDescription.getFacetMaxInclusiveValue()

getFacetMaxLengthValue

public java.lang.String getFacetMaxLengthValue()

Description copied from interface: NodeDescription

Get the value of the MAX LENGTH facet, can be null if it is not defined.

Specified by:

getFacetMaxLengthValue in interface NodeDescription

Returns:

The value of the MAX LENGTH facet.

See Also:

NodeDescription.getFacetMaxLengthValue()

getFacetMinExclusiveValue

public java.lang.String getFacetMinExclusiveValue()

Description copied from interface: NodeDescription

Get the value of the MIN_EXCLUSIVE facet, can be null if it is not defined.

Specified by:

getFacetMinExclusiveValue in interface NodeDescription

Returns:

The value of the MIN_EXCLUSIVE facet.

See Also:

NodeDescription.getFacetMinExclusiveValue()

getFacetMinInclusiveValue

public java.lang.String getFacetMinInclusiveValue()

Description copied from interface: NodeDescription

Get the value of the MIN_INCLUSIVE facet, can be null if it is not defined.

Specified by:

getFacetMinInclusiveValue in interface NodeDescription

Returns:

The value of the MIN_INCLUSIVE facet.

See Also:

NodeDescription.getFacetMinInclusiveValue()

getFacetMinLengthValue

public java.lang.String getFacetMinLengthValue()

Description copied from interface: NodeDescription

Get the value of the MIN LENGTH facet, can be null if it is not defined.

Specified by:

getFacetMinLengthValue in interface NodeDescription

Returns:

The value of the MIN LENGTH facet.

See Also:

NodeDescription.getFacetMinLengthValue()

getFacetPattern

public java.lang.String getFacetPattern()

Description copied from interface: NodeDescription

Get the value of the PATTERN facets as String, can be null if is not defined.

Specified by:

getFacetPattern in interface NodeDescription

Returns:

The PATTERN facets as a String.

See Also:

NodeDescription.getFacetPattern()

getFacetTotalDigitsValue

public java.lang.String getFacetTotalDigitsValue()

Description copied from interface: NodeDescription

Get the value of the TOTAL_DIGITS facet, can be null if it is not defined.

Specified by:

getFacetTotalDigitsValue in interface NodeDescription

Returns:

The value of the TOTAL_DIGITS facet.

See Also:

NodeDescription.getFacetTotalDigitsValue()

getFacetWhitespaceValue

public java.lang.String getFacetWhitespaceValue()

Description copied from interface: NodeDescription

Get the value of the WHITESPACE facet, can be null if it is not defined.

Specified by:

getFacetWhitespaceValue in interface NodeDescription

Returns:

The value of the WHITESPACE facet.

See Also:

NodeDescription.getFacetWhitespaceValue()

getModelDescription

public java.lang.String getModelDescription()

Description copied from interface: NodeDescription

Get the model description.

Specified by:

getModelDescription in interface NodeDescription

Returns:

The model description.

See Also:

NodeDescription.getModelDescription()

getName

public java.lang.String getName()

Description copied from interface: NodeDescription

Get the node(attribute or element) name.

Specified by:

getName in interface NodeDescription

Returns:

The node(attribute or element) name.

See Also:

NodeDescription.getName()

getPossibleValues

public java.util.List<java.lang.String> getPossibleValues()

Description copied from interface: NodeDescription

Get the possible values as a list of String values.

Specified by:

getPossibleValues in interface NodeDescription

Returns:

The list of possible values.

See Also:

NodeDescription.getPossibleValues()

setFacetFractionDigitsValue

public void setFacetFractionDigitsValue(java.lang.String fractionDigitsFacetValue)

Description copied from interface: NodeDescription

Set the value of the FRACTION_DIGITS facet.

Specified by:

setFacetFractionDigitsValue in interface NodeDescription

Parameters:

fractionDigitsFacetValue - The value of the FRACTION_DIGITS facet to set.

See Also:

NodeDescription.setFacetFractionDigitsValue(java.lang.String)

setFacetLengthValue

public void setFacetLengthValue(java.lang.String lengthFacetValue)

Description copied from interface: NodeDescription

Set the value of the LENGTH facet.

Specified by:

setFacetLengthValue in interface NodeDescription

Parameters:

lengthFacetValue - The value of the LENGTH facet to set.

See Also:

NodeDescription.setFacetLengthValue(java.lang.String)

setFacetMaxExclusiveValue

public void setFacetMaxExclusiveValue(java.lang.String maxExclusiveFacetValue)

Description copied from interface: NodeDescription

Set the value of the MAX_EXCLUSIVE facet.

Specified by:

setFacetMaxExclusiveValue in interface NodeDescription

Parameters:

maxExclusiveFacetValue - The value of the MAX_EXCLUSIVE facet to set.

See Also:

NodeDescription.setFacetMaxExclusiveValue(java.lang.String)

setFacetMaxInclusiveValue

public void setFacetMaxInclusiveValue(java.lang.String maxInclusiveFacetValue)

Description copied from interface: NodeDescription

Set the value of the MAX_INCLUSIVE facet.

Specified by:

setFacetMaxInclusiveValue in interface NodeDescription

Parameters:

maxInclusiveFacetValue - The value of the MAX_INCLUSIVE facet to set.

See Also:

NodeDescription.setFacetMaxInclusiveValue(java.lang.String)

setFacetMaxLengthValue

public void setFacetMaxLengthValue(java.lang.String maxLengthFacetValue)

Description copied from interface: NodeDescription

Set the value of the MAX_LENGTH facet.

Specified by:

setFacetMaxLengthValue in interface NodeDescription

Parameters:

maxLengthFacetValue - The value of the MAX_LENGTH facet to set.

See Also:

NodeDescription.setFacetMaxLengthValue(java.lang.String)

setFacetMinExclusiveValue

public void setFacetMinExclusiveValue(java.lang.String minExclusiveFacetValue)

Description copied from interface: NodeDescription

Set the value of the MIN_EXCLUSIVE facet.

Specified by:

setFacetMinExclusiveValue in interface NodeDescription

Parameters:

minExclusiveFacetValue - The value of the MIN_EXCLUSIVE facet to set.

See Also:

NodeDescription.setFacetMinExclusiveValue(java.lang.String)

setFacetMinInclusiveValue

public void setFacetMinInclusiveValue(java.lang.String minInclusiveFacetValue)

Description copied from interface: NodeDescription

Set the value of the MIN_INCLUSIVE facet.

Specified by:

setFacetMinInclusiveValue in interface NodeDescription

Parameters:

minInclusiveFacetValue - The value of the MIN_INCLUSIVE facet to set.

See Also:

NodeDescription.setFacetMinInclusiveValue(java.lang.String)

setFacetMinLengthValue

public void setFacetMinLengthValue(java.lang.String minLengthFacetValue)

Description copied from interface: NodeDescription

Set the value of the MIN_LENGTH facet.

Specified by:

setFacetMinLengthValue in interface NodeDescription

Parameters:

minLengthFacetValue - The value of the MIN_LENGTH facet to set.

See Also:

NodeDescription.setFacetMinLengthValue(java.lang.String)

setFacetPattern

public void setFacetPattern(java.lang.String patternFacets)

Description copied from interface: NodeDescription

Set the value of the PATTERN facets.

Specified by:

setFacetPattern in interface NodeDescription

Parameters:

patternFacets - The value of the PATTERN facets to set.

See Also:

NodeDescription.setFacetPattern(java.lang.String)

setFacetTotalDigitsValue

public void setFacetTotalDigitsValue(java.lang.String totalDigitsFacetValue)

Description copied from interface: NodeDescription

Set the value of the TOTAL_DIGITS facet.

Specified by:

setFacetTotalDigitsValue in interface NodeDescription

Parameters:

totalDigitsFacetValue - The value of the TOTAL_DIGITS facet to set.

See Also:

NodeDescription.setFacetTotalDigitsValue(java.lang.String)

setFacetWhitespaceValue

public void setFacetWhitespaceValue(java.lang.String whitespaceFacetValue)

Description copied from interface: NodeDescription

Set the value of the WHITESPACE facet.

Specified by:

setFacetWhitespaceValue in interface NodeDescription

Parameters:

whitespaceFacetValue - The value of the WHITESPACE facet to set.

See Also:

NodeDescription.setFacetWhitespaceValue(java.lang.String)

setModelDescription

public void setModelDescription(java.lang.String modelDescription)

Description copied from interface: NodeDescription

Set the model description for the node.

Specified by:

setModelDescription in interface NodeDescription

Parameters:

modelDescription - The modelDescription to set.

See Also:

NodeDescription.setModelDescription(java.lang.String)

setPossiblesValues

public void setPossiblesValues(java.util.List<java.lang.String> possiblesValues)

Description copied from interface: NodeDescription

Set the list of possible values for the node.

Specified by:

setPossiblesValues in interface NodeDescription

Parameters:

possiblesValues - The list with possible (String) values.

See Also:

NodeDescription.setPossiblesValues(java.util.List)