org.geotools.xml.schema
Interface ElementGrouping

All Known Subinterfaces:
All, Any, Choice, Element, Group, Sequence
All Known Implementing Classes:
AllGT, AnyGT, ChoiceGT, ElementGT, FilterSchema.FilterElement, GroupGT, GroupHandler.DefaultGroup, SequenceGT

public interface ElementGrouping

This represents an abstract collection of xml element definitions within a Schema.

To avoid multiple type checks, a group mask was include, as described below.

Author:
dzwiers www.refractions.net

Field Summary
static int ALL
          ElementGrouping mask to determine the type of ElementGrouping represented.
static int ANY
          ElementGrouping mask to determine the type of ElementGrouping represented.
static int CHOICE
          ElementGrouping mask to determine the type of ElementGrouping represented.
static int ELEMENT
          ElementGrouping mask to determine the type of ElementGrouping represented.
static int GROUP
          ElementGrouping mask to determine the type of ElementGrouping represented.
static int SEQUENCE
          ElementGrouping mask to determine the type of ElementGrouping represented.
static int UNBOUNDED
           
 
Method Summary
 Element findChildElement(java.lang.String name)
           Convinience method which will search for the specified element within it's children.
 int getGrouping()
           Returns the mask informing the caller as to the type of object they are dealing with.
 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.
 

Field Detail

ELEMENT

public static final int ELEMENT
ElementGrouping mask to determine the type of ElementGrouping represented. This is intended to reduce the use of the instanceof operand, increasing performance.

See Also:
Constant Field Values

GROUP

public static final int GROUP
ElementGrouping mask to determine the type of ElementGrouping represented. This is intended to reduce the use of the instanceof operand, increasing performance.

See Also:
Constant Field Values

ANY

public static final int ANY
ElementGrouping mask to determine the type of ElementGrouping represented. This is intended to reduce the use of the instanceof operand, increasing performance.

See Also:
Constant Field Values

SEQUENCE

public static final int SEQUENCE
ElementGrouping mask to determine the type of ElementGrouping represented. This is intended to reduce the use of the instanceof operand, increasing performance.

See Also:
Constant Field Values

CHOICE

public static final int CHOICE
ElementGrouping mask to determine the type of ElementGrouping represented. This is intended to reduce the use of the instanceof operand, increasing performance.

See Also:
Constant Field Values

ALL

public static final int ALL
ElementGrouping mask to determine the type of ElementGrouping represented. This is intended to reduce the use of the instanceof operand, increasing performance.

See Also:
Constant Field Values

UNBOUNDED

public static final int UNBOUNDED
See Also:
Constant Field Values
Method Detail

getGrouping

public int getGrouping()

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

Returns:

findChildElement

public Element findChildElement(java.lang.String name)

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

Parameters:
name - The Element LocalName (namespace and prefix should not be included)
Returns:
Element or null if not found.

getMaxOccurs

public int getMaxOccurs()

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

Returns:

getMinOccurs

public int getMinOccurs()

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

Returns:


Copyright © GeoTools. All Rights Reserved.