org.apache.ws.commons.schema

Class XmlSchemaGroup

java.lang.Object

org.apache.ws.commons.schema.XmlSchemaObject

org.apache.ws.commons.schema.XmlSchemaAnnotated

org.apache.ws.commons.schema.XmlSchemaGroup

All Implemented Interfaces:

XmlSchemaNamed, XmlSchemaObjectBase, XmlSchemaChoiceMember, XmlSchemaSequenceMember

public class XmlSchemaGroup
extends XmlSchemaAnnotated
implements XmlSchemaNamed, XmlSchemaChoiceMember, XmlSchemaSequenceMember

Class that defines groups at the schema level that are referenced from the complex types. Groups a set of element declarations so that they can be incorporated as a group into complex type definitions. Represents the World Wide Web Consortium (W3C) group element.

Constructor Summary

Constructors

Constructor and Description
XmlSchemaGroup(XmlSchema parent)

Method Summary

Modifier and Type	Method and Description
String	getName() Retrieve the name.
XmlSchema	getParent() Retrieve the parent schema.
XmlSchemaGroupParticle	getParticle()
QName	getQName() Get the QName for this object.
boolean	isAnonymous()
boolean	isTopLevel()
void	setName(String name) Set the name.
void	setParticle(XmlSchemaGroupParticle particle)

Methods inherited from class org.apache.ws.commons.schema.XmlSchemaAnnotated

getAnnotation, getId, getUnhandledAttributes, setAnnotation, setId, setUnhandledAttributes, toString

Methods inherited from class org.apache.ws.commons.schema.XmlSchemaObject

addMetaInfo, equals, getLineNumber, getLinePosition, getMetaInfoMap, getSourceURI, hashCode, setLineNumber, setLinePosition, setMetaInfoMap, setSourceURI

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XmlSchemaGroup

public XmlSchemaGroup(XmlSchema parent)

Method Detail

getParticle

public XmlSchemaGroupParticle getParticle()

setParticle

public void setParticle(XmlSchemaGroupParticle particle)

getName

public String getName()

Description copied from interface: XmlSchemaNamed

Retrieve the name.

Specified by:

getName in interface XmlSchemaNamed

Returns:

the local name of this object within its schema.

getParent

public XmlSchema getParent()

Description copied from interface: XmlSchemaNamed

Retrieve the parent schema.

Specified by:

getParent in interface XmlSchemaNamed

Returns:

the containing schema.

getQName

public QName getQName()

Description copied from interface: XmlSchemaNamed

Get the QName for this object. This is always the formal name that identifies this item in the schema. If the item has a form (an element or attribute), and the form is 'unqualified', this is not the appropriate QName in an instance document. For those items, the getWiredName method returns the appropriate QName for an instance document.

Specified by:

getQName in interface XmlSchemaNamed

Returns:

The qualified name of this object.

See Also:

XmlSchemaNamedWithForm.getWireName()

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface XmlSchemaNamed

Returns:

true if this object has no name.

isTopLevel

public boolean isTopLevel()

Specified by:

isTopLevel in interface XmlSchemaNamed

Returns:

true if this item is a top-level item of the schema; false if this item is nested inside of some other schema object.

setName

public void setName(String name)

Description copied from interface: XmlSchemaNamed

Set the name. Set to null to render the object anonymous, or to prepare to change it to refer to some other object.

Specified by:

setName in interface XmlSchemaNamed

Parameters:

name - the name.