org.geotools.xml.filter
Class FilterSchema.FilterElement

java.lang.Object
  org.geotools.xml.filter.FilterSchema.FilterElement

All Implemented Interfaces:

Element, ElementGrouping

Enclosing class:

FilterSchema

public static class FilterSchema.FilterElement

extends java.lang.Object

implements Element

Field Summary

Fields inherited from interface org.geotools.xml.schema.ElementGrouping

ALL, ANY, CHOICE, ELEMENT, GROUP, SEQUENCE, UNBOUNDED

Constructor Summary

FilterSchema.FilterElement(java.lang.String name, Type type)

FilterSchema.FilterElement(java.lang.String name, Type type, Element substitutionGroup)

Method Summary

Element	findChildElement(java.lang.String name1) Convinience method which will search for the specified element within it's children.
int	getBlock()
java.lang.String	getDefault() This returns the default value for the Element as a String
int	getFinal()
java.lang.String	getFixed() This returns the fixed value for the Element as a String
int	getGrouping() Returns the mask informing the caller as to the type of object they are dealing with.
java.lang.String	getId() The Schema ID for this element definition.
int	getMaxOccurs() returns the max number of allowable occurences within the xml schema for this construct.
int	getMinOccurs() returns the min number of allowable occurences within the xml schema for this construct.
java.lang.String	getName() Returns the element declaration's name in the Schema document, and element name in the instance document.
java.net.URI	getNamespace() DOCUMENT ME!
Element	getSubstitutionGroup() This returns a reference to an element representing this element's substitution group.
Type	getType() Returns the declared type for this Element in the given Schema.
boolean	isAbstract() Returns True when the instance of this XML Schema Element is abstract, false otherwise
boolean	isForm()
boolean	isNillable() Returns true when the element is nillable, false otherwise

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterSchema.FilterElement

public FilterSchema.FilterElement(java.lang.String name,
                                  Type type)

FilterSchema.FilterElement

public FilterSchema.FilterElement(java.lang.String name,
                                  Type type,
                                  Element substitutionGroup)

Method Detail

isAbstract

public boolean isAbstract()

Description copied from interface: Element

Returns True when the instance of this XML Schema Element is abstract, false otherwise

Specified by:

isAbstract in interface Element

Returns:

See Also:

Element.isAbstract()

getBlock

public int getBlock()

Specified by:

getBlock in interface Element

See Also:

Element.getBlock()

getDefault

public java.lang.String getDefault()

Description copied from interface: Element

This returns the default value for the Element as a String

Specified by:

getDefault in interface Element

Returns:

See Also:

Element.getDefault()

getFinal

public int getFinal()

Specified by:

getFinal in interface Element

See Also:

Element.getFinal()

getFixed

public java.lang.String getFixed()

Description copied from interface: Element

This returns the fixed value for the Element as a String

Specified by:

getFixed in interface Element

Returns:

See Also:

Element.getFixed()

isForm

public boolean isForm()

Specified by:

isForm in interface Element

See Also:

Element.isForm()

getId

public java.lang.String getId()

Description copied from interface: Element

The Schema ID for this element definition.

Specified by:

getId in interface Element

Returns:

See Also:

Element.getId()

getMaxOccurs

public int getMaxOccurs()

Description copied from interface: ElementGrouping

returns the max number of allowable occurences within the xml schema for this construct.

Specified by:

getMaxOccurs in interface Element

See Also:

Element.getMaxOccurs()

getMinOccurs

public int getMinOccurs()

Description copied from interface: ElementGrouping

returns the min number of allowable occurences within the xml schema for this construct.

Specified by:

getMinOccurs in interface Element

See Also:

Element.getMinOccurs()

getName

public java.lang.String getName()

Description copied from interface: Element

Returns the element declaration's name in the Schema document, and element name in the instance document.

Specified by:

getName in interface Element

Returns:

See Also:

Element.getName()

getNamespace

public java.net.URI getNamespace()

Description copied from interface: Element

DOCUMENT ME!

Specified by:

getNamespace in interface Element

Returns:

See Also:

Element.getNamespace()

isNillable

public boolean isNillable()

Description copied from interface: Element

Returns true when the element is nillable, false otherwise

Specified by:

isNillable in interface Element

Returns:

See Also:

Element.isNillable()

getSubstitutionGroup

public Element getSubstitutionGroup()

Description copied from interface: Element

This returns a reference to an element representing this element's substitution group. This is of particular importance when resolving an instance document's value.

Specified by:

getSubstitutionGroup in interface Element

Returns:

See Also:

Element.getSubstitutionGroup()

getType

public Type getType()

Description copied from interface: Element

Returns the declared type for this Element in the given Schema.

Specified by:

getType in interface Element

Returns:

See Also:

Element.getType()

getGrouping

public int getGrouping()

Description copied from interface: ElementGrouping

Returns the mask informing the caller as to the type of object they are dealing with.

Specified by:

getGrouping in interface ElementGrouping

Returns:

See Also:

ElementGrouping.getGrouping()

findChildElement

public Element findChildElement(java.lang.String name1)

Description copied from interface: ElementGrouping

Convinience method which will search for the specified element within it's children. This is typically implemented recursively, and as such may be expensive to execute (so don't call me too much if you want to be fast).

Specified by:

findChildElement in interface ElementGrouping

Parameters:

name1 - The Element LocalName (namespace and prefix should not be included)

Returns:

Element or null if not found.

See Also:

ElementGrouping.findChildElement(java.lang.String)