org.geotools.xml.schema.impl

Class ComplexTypeGT

Object

ComplexTypeGT

All Implemented Interfaces:

ComplexType, Type

Direct Known Subclasses:

ogcComplexType, sldComplexType

public class ComplexTypeGT
extends Object
implements ComplexType

Provides ...TODO summary sentence

TODO Description

Responsibilities:

Example Use:

 ComplexTypeGT x = new ComplexTypeGT( ... );
 TODO code example
 

Since:

0.3

Author:

dzwiers

Constructor Summary

Constructors

Constructor and Description
ComplexTypeGT(String id, String name, URI namespace, ElementGrouping child, Attribute[] attrs, Element[] elems, boolean mixed, Type parent, boolean _abstract, boolean derived, String anyAttributeNS) Construct ComplexTypeGT.

Method Summary

Modifier and Type	Method and Description
boolean	cache(Element element, Map<String,Object> hints) TODO summary sentence for cache ...
boolean	canEncode(Element element, Object value, Map<String,Object> hints) TODO summary sentence for canEncode ...
void	encode(Element element, Object value, PrintHandler output, Map<String,Object> hints) TODO summary sentence for encode ...
Element	findChildElement(String name1) TODO summary sentence for findChildElement ...
String	getAnyAttributeNameSpace() TODO summary sentence for getAnyAttributeNameSpace ...
Attribute[]	getAttributes() TODO summary sentence for getAttributes ...
int	getBlock() TODO summary sentence for getBlock ...
ElementGrouping	getChild() TODO summary sentence for getChild ...
Element[]	getChildElements() TODO summary sentence for getChildElements ...
int	getFinal() TODO summary sentence for getFinal ...
String	getId() TODO summary sentence for getId ...
Class	getInstanceType() TODO summary sentence for getInstanceType ...
String	getName() TODO summary sentence for getName ...
URI	getNamespace() TODO summary sentence for getNamespace ...
Type	getParent() TODO summary sentence for getParent ...
Object	getValue(Element element, ElementValue[] value, Attributes attrs1, Map<String,Object> hints) TODO summary sentence for getValue ...
boolean	isAbstract() TODO summary sentence for isAbstract ...
boolean	isDerived() TODO summary sentence for isDerived ...
boolean	isMixed() TODO summary sentence for isMixed ...

Methods inherited from class Object

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

Constructor Detail

ComplexTypeGT

public ComplexTypeGT(String id,
                     String name,
                     URI namespace,
                     ElementGrouping child,
                     Attribute[] attrs,
                     Element[] elems,
                     boolean mixed,
                     Type parent,
                     boolean _abstract,
                     boolean derived,
                     String anyAttributeNS)

Construct ComplexTypeGT.

Method Detail

getParent

public Type getParent()

TODO summary sentence for getParent ...

Specified by:

getParent in interface ComplexType

See Also:

ComplexType.getParent()

isAbstract

public boolean isAbstract()

TODO summary sentence for isAbstract ...

Specified by:

isAbstract in interface ComplexType

See Also:

ComplexType.isAbstract()

getAnyAttributeNameSpace

public String getAnyAttributeNameSpace()

TODO summary sentence for getAnyAttributeNameSpace ...

Specified by:

getAnyAttributeNameSpace in interface ComplexType

See Also:

ComplexType.getAnyAttributeNameSpace()

getAttributes

public Attribute[] getAttributes()

TODO summary sentence for getAttributes ...

Specified by:

getAttributes in interface ComplexType

See Also:

ComplexType.getAttributes()

getBlock

public int getBlock()

TODO summary sentence for getBlock ...

Specified by:

getBlock in interface ComplexType

See Also:

ComplexType.getBlock()

getChild

public ElementGrouping getChild()

TODO summary sentence for getChild ...

Specified by:

getChild in interface ComplexType

See Also:

ComplexType.getChild()

getChildElements

public Element[] getChildElements()

TODO summary sentence for getChildElements ...

Specified by:

getChildElements in interface ComplexType

See Also:

ComplexType.getChildElements()

getFinal

public int getFinal()

TODO summary sentence for getFinal ...

Specified by:

getFinal in interface ComplexType

See Also:

ComplexType.getFinal()

getId

public String getId()

TODO summary sentence for getId ...

Specified by:

getId in interface ComplexType

See Also:

ComplexType.getId()

isMixed

public boolean isMixed()

TODO summary sentence for isMixed ...

Specified by:

isMixed in interface ComplexType

See Also:

ComplexType.isMixed()

isDerived

public boolean isDerived()

TODO summary sentence for isDerived ...

Specified by:

isDerived in interface ComplexType

See Also:

ComplexType.isDerived()

cache

public boolean cache(Element element,
                     Map<String,Object> hints)

TODO summary sentence for cache ...

Specified by:

cache in interface ComplexType

Returns:

True, except when streaming the element.

See Also:

ComplexType.cache(org.geotools.xml.schema.Element, java.util.Map)

getValue

public Object getValue(Element element,
                       ElementValue[] value,
                       Attributes attrs1,
                       Map<String,Object> hints)
                throws OperationNotSupportedException,
                       SAXException

TODO summary sentence for getValue ...

Specified by:

getValue in interface Type

Returns:

Object

Throws:

OperationNotSupportedException

SAXException

See Also:

Type.getValue(org.geotools.xml.schema.Element, org.geotools.xml.schema.ElementValue[], org.xml.sax.Attributes, java.util.Map)

getName

public String getName()

TODO summary sentence for getName ...

Specified by:

getName in interface Type

See Also:

Type.getName()

getNamespace

public URI getNamespace()

TODO summary sentence for getNamespace ...

Specified by:

getNamespace in interface Type

See Also:

Type.getNamespace()

getInstanceType

public Class getInstanceType()

TODO summary sentence for getInstanceType ...

Specified by:

getInstanceType in interface Type

See Also:

Type.getInstanceType()

canEncode

public boolean canEncode(Element element,
                         Object value,
                         Map<String,Object> hints)

TODO summary sentence for canEncode ...

Specified by:

canEncode in interface Type

Parameters:

element - The element which may be used to represent the Object. This is included to allow for child definitions to include addition information where appropriate.

value - An Object which may or may not be encodeable by this type. The value may also be null.

Returns:

True when the encode method can interpret the given element/value pair into valid xml.

See Also:

Type.canEncode(org.geotools.xml.schema.Element, java.lang.Object, java.util.Map)

encode

public void encode(Element element,
                   Object value,
                   PrintHandler output,
                   Map<String,Object> hints)
            throws OperationNotSupportedException

TODO summary sentence for encode ...

Specified by:

encode in interface Type

Parameters:

element - The original element declaration to which we should encode.

value - The Object to encode.

output - This is where the output should be written to.

hints - For providing additional context information to specific schemas.

Throws:

OperationNotSupportedException - When this type cannot be encoded ... and wasn't checked first.

See Also:

Type.encode(org.geotools.xml.schema.Element, java.lang.Object, org.geotools.xml.PrintHandler, java.util.Map)

findChildElement

public Element findChildElement(String name1)

TODO summary sentence for findChildElement ...

Specified by:

findChildElement in interface Type

Parameters:

name1 - the element's localName to search for.

See Also:

Type.findChildElement(java.lang.String)