org.exolab.castor.xml.schema

Class Wildcard

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.Particle

org.exolab.castor.xml.schema.Wildcard

All Implemented Interfaces:

Serializable

public class Wildcard
extends Particle

A class that represents an XML Schema Wildcard. A wilcard is represented by the XML elements <any> and <anyAttribute> and can be hold in a complexType or in a ModelGroup ().

Author:

Arnaud Blandin

See Also:

Serialized Form

Field Summary

Fields inherited from class org.exolab.castor.xml.schema.Particle

UNBOUNDED

Fields inherited from class org.exolab.castor.xml.schema.Structure

ANNOTATION, ANYTYPE, APPINFO, ATTRIBUTE, ATTRIBUTE_GROUP, COMPLEX_CONTENT, COMPLEX_TYPE, DOCUMENTATION, ELEMENT, FACET, GROUP, IDENTITY_FIELD, IDENTITY_SELECTOR, KEY, KEYREF, LIST, MODELGROUP, MODELGROUP_REF, REDEFINE, SCHEMA, SIMPLE_CONTENT, SIMPLE_TYPE, UNION, UNIQUE, UNKNOWN, WILDCARD

Constructor Summary

Constructors

Constructor and Description
Wildcard(AttributeGroup attGroup) The wildcard is embedded in an AttributeGroup.
Wildcard(ComplexType complexType) The wildcard is embedded in a complexType
Wildcard(Group group) The wildcard is embedded in a ModelGroup ()

Method Summary

Modifier and Type	Method and Description
void	addNamespace(String Namespace) add a namespace
AttributeGroup	getAttributeGroup() Returns the AttributeGroup that contains this wilcard (can return null)
ComplexType	getComplexType() Returns the complexType that contains this wildcard, can return null.
Group	getModelGroup() Returns the model group that contains this wildcard, can return null.
Enumeration<String>	getNamespaces() Returns an enumeration that contains the different namespaces of this wildcard
String	getProcessContent() Returns the processContent of this wildcard
Schema	getSchema() Returns the parent schema in which this wildcard is located.
short	getStructureType() Returns the type of this Schema Structure
boolean	isAttributeWildcard() Returns true if this wildcard represents <anyAttribute> otherwise false
boolean	removeNamespace(String namespace) Removes the given namespace from the namespace collection
void	setAttributeWildcard() Sets this wildcard to represent <anyAttribute>
void	setId(String id) Sets the ID for this Group
void	setProcessContents(String process) Sets the processContent of the wildCard
void	validate() Checks the validity of this Schema defintion.

Methods inherited from class org.exolab.castor.xml.schema.Particle

getMaxOccurs, getMinOccurs, isEmptiable, isMaxOccursSet, isMinOccursSet, setMaxOccurs, setMinOccurs

Methods inherited from class org.exolab.castor.xml.schema.Annotated

addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.Structure

isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

Wildcard

public Wildcard(ComplexType complexType)

The wildcard is embedded in a complexType

Parameters:

complexType - the complexType that contains this wildcard

Wildcard

public Wildcard(Group group)

The wildcard is embedded in a ModelGroup ()

Parameters:

group - the ModelGoup that contains this wildcard

Wildcard

public Wildcard(AttributeGroup attGroup)

The wildcard is embedded in an AttributeGroup.

Parameters:

attGroup - the AttributeGroup that contains this wildcard

Method Detail

addNamespace

public void addNamespace(String Namespace)

add a namespace

Parameters:

Namespace - the namespace to add

removeNamespace

public boolean removeNamespace(String namespace)

Removes the given namespace from the namespace collection

Parameters:

namespace - the namespace to remove.

getComplexType

public ComplexType getComplexType()

Returns the complexType that contains this wildcard, can return null.

Returns:

the complexType that contains this wildcard (can be null).

getModelGroup

public Group getModelGroup()

Returns the model group that contains this wildcard, can return null.

Returns:

the model group that contains this wildcard (can be null).

getAttributeGroup

public AttributeGroup getAttributeGroup()

Returns the AttributeGroup that contains this wilcard (can return null)

Returns:

the AttributeGroup that contains this wilcard (can return null)

getSchema

public Schema getSchema()

Returns the parent schema in which this wildcard is located.

Returns:

the schema that contains the parent structure of this wildcard.

getNamespaces

public Enumeration<String> getNamespaces()

Returns an enumeration that contains the different namespaces of this wildcard

Returns:

an enumeration that contains the different namespaces of this wildcard

getProcessContent

public String getProcessContent()

Returns the processContent of this wildcard

Returns:

the processContent of this wildcard

isAttributeWildcard

public boolean isAttributeWildcard()

Returns true if this wildcard represents <anyAttribute> otherwise false

Returns:

true if this wildcard represents <anyAttribute> otherwise false

setAttributeWildcard

public void setAttributeWildcard()

Sets this wildcard to represent <anyAttribute>

setId

public void setId(String id)

Sets the ID for this Group

Parameters:

id - the ID for this Group

setProcessContents

public void setProcessContents(String process)
                        throws SchemaException

Sets the processContent of the wildCard

Parameters:

process - the process content to set

Throws:

SchemaException - thrown when the processContent is not valid

validate

public void validate()
              throws ValidationException

Description copied from class: Structure

Checks the validity of this Schema defintion.

Specified by:

validate in class Structure

Throws:

ValidationException - when this Schema definition is invalid.

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure