org.apache.ws.commons.schema.utils

Interface XmlSchemaNamed

All Superinterfaces:

XmlSchemaObjectBase

All Known Subinterfaces:

XmlSchemaNamedWithForm

All Known Implementing Classes:

XmlSchemaAttribute, XmlSchemaAttributeGroup, XmlSchemaComplexType, XmlSchemaElement, XmlSchemaGroup, XmlSchemaNamedImpl, XmlSchemaNamedWithFormImpl, XmlSchemaNotation, XmlSchemaSimpleType, XmlSchemaType

public interface XmlSchemaNamed
extends XmlSchemaObjectBase

A named item. Named items have two names; their schema-local name (a string) and a QName qualified by their schema's target namespace. Note that the qualified name is not the on-the-wire name for attributes and elements. Those names depend on the form, and are managed by XmlSchemaNamedWithForm.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Retrieve the name.
XmlSchema	getParent() Retrieve the parent schema.
javax.xml.namespace.QName	getQName() Get the QName for this object.
boolean	isAnonymous()
boolean	isTopLevel()
void	setName(java.lang.String name) Set the name.

Method Detail

getName

java.lang.String getName()

Retrieve the name.

Returns:

the local name of this object within its schema.

isAnonymous

boolean isAnonymous()

Returns:

true if this object has no name.

setName

void setName(java.lang.String name)

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

Parameters:

name - the name.

getParent

XmlSchema getParent()

Retrieve the parent schema.

Returns:

the containing schema.

getQName

javax.xml.namespace.QName getQName()

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.

Returns:

The qualified name of this object.

See Also:

XmlSchemaNamedWithForm.getWireName()

isTopLevel

boolean isTopLevel()

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.