org.geotools.xml.schema
Interface ComplexType

All Superinterfaces:

Type

All Known Implementing Classes:

ComplexTypeGT, org.geotools.xml.filter.FilterSchema.FilterComplexType, org.geotools.xml.gml.GMLSchema.GMLComplexType, org.geotools.data.wms.xml.WMSSchema.WMSComplexType, XSISimpleTypes.AnyType

public interface ComplexType

extends Type

This interface is intended to represent an XML Schema complexType. This interface extends the generic XML schema type interface to represent datum within nested elements.

Author:

dzwiers www.refractions.net

Method Summary

boolean	cache(Element element, java.util.Map hints) This method is a directive to the parser whether to keep the data around in memory for post processing.
java.lang.String	getAnyAttributeNameSpace() This methos represents the potential 'anyAttribute' declaration's namespace attribute which may occur within a complex type definition.
Attribute[]	getAttributes() The set of attributes required by this complex type declaration.
int	getBlock() Specifies a mask which denotes which substitution mechanisms may be used for this complex type definition.
ElementGrouping	getChild() Returns the child element representing the structure of nested child nodes (if any are allowed).
Element[]	getChildElements()
int	getFinal() Specifies a mask which denotes which substitution mechanisms prohibited for use by child definitions of this complex type.
java.lang.String	getId() Returns the xml schema id of this complexType if one exists, null otherwise.
Type	getParent() This is used to represent the heirarchy represented within an xml schema document(s).
boolean	isAbstract() Returns true when the complexType should be considered abstract, as defined by the XML schema of which this complex type definition is a part.
boolean	isDerived() This method is used to publish whether this complexType is at the root of an inheritance tree, or a leaf within an inheritance tree.
boolean	isMixed() Returns true if this complexType allows mixed content (Child elements and a String value).

Methods inherited from interface org.geotools.xml.schema.Type

canEncode, encode, findChildElement, getInstanceType, getName, getNamespace, getValue

Method Detail

getParent

public Type getParent()

This is used to represent the heirarchy represented within an xml schema document(s). This is particularily useful, as the parent will have the first attempt to create a real (non Object[]) value of the element. For more information see getValue.

Returns:

See Also:

Type#getValue(Element, ElementValue[], Attributes)

isAbstract

public boolean isAbstract()

Returns true when the complexType should be considered abstract, as defined by the XML schema of which this complex type definition is a part.

Returns:

getAnyAttributeNameSpace

public java.lang.String getAnyAttributeNameSpace()

This methos represents the potential 'anyAttribute' declaration's namespace attribute which may occur within a complex type definition.

Returns:

getAttributes

public Attribute[] getAttributes()

The set of attributes required by this complex type declaration. As per the xml schema definition, there is not an implied order to the attributes. For performance reasons an implementor may wich to order the attributes from most common to least commonly used attributes.

Returns:

getBlock

public int getBlock()

Specifies a mask which denotes which substitution mechanisms may be used for this complex type definition.

Returns:

See Also:

Schema.EXTENSION, Schema.RESTRICTION, Schema.ALL

getChild

public ElementGrouping getChild()

Returns the child element representing the structure of nested child nodes (if any are allowed).

Returns:

See Also:

ElementGrouping

getChildElements

public Element[] getChildElements()

getFinal

public int getFinal()

Specifies a mask which denotes which substitution mechanisms prohibited for use by child definitions of this complex type.

Returns:

See Also:

Schema.EXTENSION, Schema.RESTRICTION, Schema.ALL

getId

public java.lang.String getId()

Returns the xml schema id of this complexType if one exists, null otherwise.

Returns:

isMixed

public boolean isMixed()

Returns true if this complexType allows mixed content (Child elements and a String value).

Returns:

isDerived

public boolean isDerived()

This method is used to publish whether this complexType is at the root of an inheritance tree, or a leaf within an inheritance tree. This method should return true when the complexType is not a root of an inheritance tree.

Returns:

cache

public boolean cache(Element element,
                     java.util.Map hints)

This method is a directive to the parser whether to keep the data around in memory for post processing. Generally this should return True, except when streaming.

Parameters:

element - DOCUMENT ME!

hints - DOCUMENT ME!

Returns:

True, except when streaming the element.