Package org.geotools.xml.xsi

Class XSISimpleTypes.XSISimpleType

Object

XSISimpleType

All Implemented Interfaces:

SimpleType, Type

Direct Known Subclasses:

XSISimpleTypes.AnyType, XSISimpleTypes.AnyURI, XSISimpleTypes.Base64Binary, XSISimpleTypes.Boolean, XSISimpleTypes.Byte, XSISimpleTypes.Date, XSISimpleTypes.DateTime, XSISimpleTypes.Decimal, XSISimpleTypes.Double, XSISimpleTypes.Duration, XSISimpleTypes.ENTITIES, XSISimpleTypes.ENTITY, XSISimpleTypes.Float, XSISimpleTypes.gDay, XSISimpleTypes.gMonth, XSISimpleTypes.gMonthDay, XSISimpleTypes.gYear, XSISimpleTypes.gYearMonth, XSISimpleTypes.HexBinary, XSISimpleTypes.ID, XSISimpleTypes.IDREF, XSISimpleTypes.IDREFS, XSISimpleTypes.Int, XSISimpleTypes.Integer, XSISimpleTypes.Language, XSISimpleTypes.Long, XSISimpleTypes.Name, XSISimpleTypes.NCName, XSISimpleTypes.NegativeInteger, XSISimpleTypes.NMTOKEN, XSISimpleTypes.NMTOKENS, XSISimpleTypes.NonNegativeInteger, XSISimpleTypes.NonPositiveInteger, XSISimpleTypes.NormalizedString, XSISimpleTypes.NOTATION, XSISimpleTypes.PositiveInteger, XSISimpleTypes.QName, XSISimpleTypes.Short, XSISimpleTypes.String, XSISimpleTypes.Time, XSISimpleTypes.Token, XSISimpleTypes.UnsignedByte, XSISimpleTypes.UnsignedInt, XSISimpleTypes.UnsignedLong, XSISimpleTypes.UnsignedShort

Enclosing class:

XSISimpleTypes

protected abstract static class XSISimpleTypes.XSISimpleType
extends Object
implements SimpleType

A generic implementation of a SimpleType for use by the xsi Schema.

Author:

dzwiers

Field Summary

Fields inherited from interface SimpleType

ALL, LIST, NONE, RESTRICTION, UNION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XSISimpleType()

Method Summary

Modifier and Type	Method	Description
boolean	canCreateAttributes(Attribute attribute, Object value, Map<String,Object> hints)
boolean	canEncode(Element element, Object value, Map<String,Object> hints)	Can I write this object out as element specified?
void	encode(Element element, Object value, PrintHandler output, Map<String,Object> hints)	Encode value as element on the provided output.
Element	findChildElement(String name)	Convinience method used to search this type's children for the requested element by localName.
Element	findChildElement(XSISimpleTypes.String name)
int	getChildType()	Returns an int of either List, Union or Restriction
Facet[]	getFacets()	The list of facets for this Restriction ...
int	getFinal()	This specifies a mask which represents how this XML Schema SimpleType may be extended/restricted ... through Schema declared derivations.
String	getId()	The Schema ID for this simpleType definition.
static SimpleType	getInstance()	This method is intended to return an instance of the implemented type.
URI	getNamespace()	This is used for validation of an XML document, and represents the targetNamespace of that this type resides in.
Type	getParent()
SimpleType[]	getParents()	A simple simpleType when either a List or Restriction ...
AttributeValue	toAttribute(Attribute attribute, Object value, Map<String,Object> hints)	returns the value as a string

Methods inherited from class Object

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

Methods inherited from interface Type

getInstanceType, getName, getValue

Constructor Detail

XSISimpleType

protected XSISimpleType()

Method Detail

findChildElement

public Element findChildElement(XSISimpleTypes.String name)

See Also:

Type.findChildElement(java.lang.String)

canCreateAttributes

public boolean canCreateAttributes(Attribute attribute,
                                   Object value,
                                   Map<String,Object> hints)

Specified by:

canCreateAttributes in interface SimpleType

See Also:

SimpleType.canCreateAttributes(org.geotools.xml.schema.Attribute, java.lang.Object, java.util.Map)

canEncode

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

Description copied from interface: Type

Can I write this object out as element specified?

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)

toAttribute

public AttributeValue toAttribute(Attribute attribute,
                                  Object value,
                                  Map<String,Object> hints)

Description copied from interface: SimpleType

returns the value as a string

Specified by:

toAttribute in interface SimpleType

See Also:

SimpleType.toAttribute(org.geotools.xml.schema.Attribute, java.lang.Object, java.util.Map)

encode

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

Description copied from interface: Type

Encode value as element on the provided output.

This is encoding because the PrintHandler does not have to go back to a stream.

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:

IOException - When there is an error with the Writer.

See Also:

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

getInstance

public static SimpleType getInstance()

This method is intended to return an instance of the implemented type.

Returns:

SimpleType

Throws:

RuntimeException - when not overridden

getParent

public Type getParent()

See Also:

org.geotools.xml.xsi.Type#getParent()

getNamespace

public URI getNamespace()

Description copied from interface: Type

This is used for validation of an XML document, and represents the targetNamespace of that this type resides in.

Specified by:

getNamespace in interface Type

See Also:

org.geotools.xml.xsi.Type#getNamespace()

getFinal

public int getFinal()

Description copied from interface: SimpleType

This specifies a mask which represents how this XML Schema SimpleType may be extended/restricted ... through Schema declared derivations.

Specified by:

getFinal in interface SimpleType

See Also:

org.geotools.xml.xsi.SimpleType#getFinal()

getId

public String getId()

Description copied from interface: SimpleType

The Schema ID for this simpleType definition.

Specified by:

getId in interface SimpleType

See Also:

org.geotools.xml.xsi.SimpleType#getId()

getChildType

public int getChildType()

Description copied from interface: SimpleType

Returns an int of either List, Union or Restriction

Specified by:

getChildType in interface SimpleType

See Also:

SimpleType.getChildType()

getParents

public SimpleType[] getParents()

Description copied from interface: SimpleType

A simple simpleType when either a List or Restriction ... A set when a Union

Specified by:

getParents in interface SimpleType

See Also:

SimpleType.getParents()

getFacets

public Facet[] getFacets()

Description copied from interface: SimpleType

The list of facets for this Restriction ... Null if another type (List, Union)

Specified by:

getFacets in interface SimpleType

See Also:

SimpleType.getFacets()

findChildElement

public Element findChildElement(String name)

Description copied from interface: Type

Convinience method used to search this type's children for the requested element by localName.

Specified by:

findChildElement in interface Type

Parameters:

name - the element's localName to search for.

See Also:

Type.findChildElement(java.lang.String)