org.geotools.xml.schema.impl
Class ChoiceGT

java.lang.Object
  org.geotools.xml.schema.impl.ChoiceGT

All Implemented Interfaces:

Choice, ElementGrouping

public class ChoiceGT

extends java.lang.Object

implements Choice

DOCUMENT ME!

Author:

dzwiers

Field Summary

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

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

Constructor Summary

ChoiceGT(ElementGrouping[] children)

ChoiceGT(java.lang.String id, int min, int max, ElementGrouping[] children)
Creates a new ChoiceGT object.

Method Summary

Element	findChildElement(java.lang.String name) Convinience method which will search for the specified element within it's children.
ElementGrouping[]	getChildren() This method returns a list of children which repreensts the options for the element which this choice is representing in an XML Schema.
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 choice 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceGT

public ChoiceGT(java.lang.String id,
                int min,
                int max,
                ElementGrouping[] children)

Creates a new ChoiceGT object.

Parameters:

id - DOCUMENT ME!

min - DOCUMENT ME!

max - DOCUMENT ME!

children - DOCUMENT ME!

ChoiceGT

public ChoiceGT(ElementGrouping[] children)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Choice

The Schema ID for this choice definition.

Specified by:

getId in interface Choice

Returns:

See Also:

Choice.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 Choice

See Also:

ElementGrouping.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 Choice

See Also:

ElementGrouping.getMinOccurs()

getChildren

public ElementGrouping[] getChildren()

Description copied from interface: Choice

This method returns a list of children which repreensts the options for the element which this choice is representing in an XML Schema. Although the list is semantically a set, we encourage you to add elements to the list as they apear, to allow Schema writers to optimize the search order.

Specified by:

getChildren in interface Choice

Returns:

See Also:

Choice.getChildren()

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 name)

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:

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

Returns:

Element or null if not found.

See Also:

ElementGrouping.findChildElement(java.lang.String)