org.exolab.castor.xml.schema

Interface ContentModelGroup

public interface ContentModelGroup

An XML Schema ModelGroup

Version: $Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:29 $

Author: Keith Visco

Method Summary
voidaddElementDecl(ElementDecl elementDecl)
Adds the given ElementDecl to this ContentModelGroup
voidaddGroup(Group group)
Adds the given Group to this ContentModelGroup
voidaddGroup(ModelGroup group)
Adds the given ModelGroup Definition to this ContentModelGroup
voidaddWildcard(Wildcard wilcard)
Adds the given wildcard to this ContentModelGroup
Enumerationenumerate()
Returns an enumeration of all the Particles contained within this ContentModelGroup
ElementDeclgetElementDecl(String name)
Returns the element declaration with the given name, or null if no element declaration with that name exists in this ContentModelGroup.
intgetMaxOccurs()
Returns the maximum number of occurances that this ContentModelGroup may appear
intgetMinOccurs()
Returns the minimum number of occurances that this ContentModelGroup must appear
ParticlegetParticle(int index)
Returns the Particle at the specified index
intgetParticleCount()
Returns the number of particles contained within this ContentModelGroup
booleanremoveElementDecl(ElementDecl elementDecl)
Removes the given ElementDecl from this ContentModelGroup.
booleanremoveGroup(Group group)
Removes the given Group from this ContentModelGroup.
booleanremoveGroup(ModelGroup group)
Removes the given ModelGroup Definition from this ContentModelGroup.
booleanremoveWildcard(Wildcard wildcard)
Removes the given Wildcard from this ContentModelGroup.

Method Detail

addElementDecl

public void addElementDecl(ElementDecl elementDecl)
Adds the given ElementDecl to this ContentModelGroup

Parameters: elementDecl the ElementDecl to add

Throws: SchemaException when an ElementDecl already exists with the same name as the given ElementDecl

addGroup

public void addGroup(Group group)
Adds the given Group to this ContentModelGroup

Parameters: group the Group to add

Throws: SchemaException when a group with the same name as the specified group already exists in the current scope

addGroup

public void addGroup(ModelGroup group)
Adds the given ModelGroup Definition to this ContentModelGroup

Parameters: group the ModelGroup to add

Throws: SchemaException when a group with the same name as the specified group already exists in the current scope

addWildcard

public void addWildcard(Wildcard wilcard)
Adds the given wildcard to this ContentModelGroup

Parameters: wilcard the wilcard to add

Throws: SchemaException when the wilcard is and not

enumerate

public Enumeration enumerate()
Returns an enumeration of all the Particles contained within this ContentModelGroup

Returns: an enumeration of all the Particels contained within this ContentModelGroup

getElementDecl

public ElementDecl getElementDecl(String name)
Returns the element declaration with the given name, or null if no element declaration with that name exists in this ContentModelGroup.

Parameters: name the name of the element.

Returns: the ElementDecl with the given name, or null if no ElementDecl exists in this ContentModelGroup.

getMaxOccurs

public int getMaxOccurs()
Returns the maximum number of occurances that this ContentModelGroup may appear

Returns: the maximum number of occurances that this ContentModelGroup may appear. A non positive (n < 1) value indicates that the value is unspecified (ie. unbounded).

getMinOccurs

public int getMinOccurs()
Returns the minimum number of occurances that this ContentModelGroup must appear

Returns: the minimum number of occurances that this ContentModelGroup must appear A negative (n < 0) value indicates that the value is unspecified.

getParticle

public Particle getParticle(int index)
Returns the Particle at the specified index

Parameters: index the index of the particle to return

UNKNOWN: the CMParticle at the specified index

getParticleCount

public int getParticleCount()
Returns the number of particles contained within this ContentModelGroup

Returns: the number of particles

removeElementDecl

public boolean removeElementDecl(ElementDecl elementDecl)
Removes the given ElementDecl from this ContentModelGroup.

Parameters: elementDecl the ElementDecl to remove.

Returns: true if the element has been successfully removed, false otherwise.

removeGroup

public boolean removeGroup(Group group)
Removes the given Group from this ContentModelGroup.

Parameters: group the Group to remove.

Returns: true if the group has been successfully removed, false otherwise.

removeGroup

public boolean removeGroup(ModelGroup group)
Removes the given ModelGroup Definition from this ContentModelGroup.

Parameters: group the ModelGroup Definition to remove.

Returns: true if the group has been successfully removed, false otherwise.

removeWildcard

public boolean removeWildcard(Wildcard wildcard)
Removes the given Wildcard from this ContentModelGroup.

Parameters: group the Wilcard to remove.

Returns: true if the wildcard has been successfully removed, false otherwise.

Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com