org.apache.ws.jaxme.generator.sg
Interface ParticleSG

All Known Implementing Classes:
ParticleSGImpl

public interface ParticleSG

Interface of a particle.


Method Summary
 void forAllNonNullValues(JavaMethod pMethod, DirectAccessible pElement, SGlet pSGlet)
          Invokes the given SGlet for all non null values.
 GroupSG getGroupSG()
          If the particle is a group, returns the particles GroupSG.
 org.xml.sax.Locator getLocator()
          Returns the particles locator.
 int getMaxOccurs()
          Returns the particles maxOccurs value; -1 indicated "unbounded".
 int getMinOccurs()
          Returns the particles minOccurs value.
 ObjectSG getObjectSG()
          If the particle is an element or wildcard, returns the particles ObjectSG.
 PropertySG getPropertySG()
          Returns an instance of PropertySG.
 void init()
          Initializes the ParticleSG.
 boolean isElement()
          Returns whether the particle is an element.
 boolean isGroup()
          Returns whether the pariticle is a group.
 boolean isMultiple()
          Returns whether the particles multiplicity is 2 or greater.
 boolean isWildcard()
          Returns whether the particle is a wildcard.
 java.lang.Object newPropertySGChain()
          Creates a new instance of PropertySGChain.
 

Method Detail

init

void init()
          throws org.xml.sax.SAXException

Initializes the ParticleSG.

Throws:
org.xml.sax.SAXException

getLocator

org.xml.sax.Locator getLocator()

Returns the particles locator.


isGroup

boolean isGroup()

Returns whether the pariticle is a group. If so, you may use the getGroupSG() method.

See Also:
getGroupSG()

isElement

boolean isElement()

Returns whether the particle is an element. If so, you may use the getObjectSG() method.

See Also:
getObjectSG()

isWildcard

boolean isWildcard()

Returns whether the particle is a wildcard. If so, you may use the getObjectSG() method.

See Also:
getObjectSG()

getGroupSG

GroupSG getGroupSG()

If the particle is a group, returns the particles GroupSG.

Throws:
java.lang.IllegalStateException - The particle is no group.
See Also:
isGroup()

getObjectSG

ObjectSG getObjectSG()

If the particle is an element or wildcard, returns the particles ObjectSG.

Throws:
java.lang.IllegalStateException - The particle is neither an element nor a wildcard
See Also:
isElement(), isWildcard()

getMinOccurs

int getMinOccurs()

Returns the particles minOccurs value.

See Also:
getMaxOccurs()

getMaxOccurs

int getMaxOccurs()

Returns the particles maxOccurs value; -1 indicated "unbounded".

See Also:
isMultiple(), getMinOccurs()

isMultiple

boolean isMultiple()

Returns whether the particles multiplicity is 2 or greater.

See Also:
getMaxOccurs()

newPropertySGChain

java.lang.Object newPropertySGChain()
                                    throws org.xml.sax.SAXException

Creates a new instance of PropertySGChain.

Throws:
org.xml.sax.SAXException

getPropertySG

PropertySG getPropertySG()
                         throws org.xml.sax.SAXException

Returns an instance of PropertySG.

Throws:
org.xml.sax.SAXException

forAllNonNullValues

void forAllNonNullValues(JavaMethod pMethod,
                         DirectAccessible pElement,
                         SGlet pSGlet)
                         throws org.xml.sax.SAXException

Invokes the given SGlet for all non null values.

Throws:
org.xml.sax.SAXException