com.luciad.format.xml.bind.schema

LuciadLightspeedClass TLcdXMLSchemaElementIdentifier

java.lang.Object

com.luciad.format.xml.bind.schema.TLcdXMLSchemaElementIdentifier

public class TLcdXMLSchemaElementIdentifier
extends java.lang.Object

An identifier for XML schema elements.

The following table gives an overview of which types exist and how they are represented by a TLcdXMLSchemaTypeIdentifier.

Schema element	TypeName value	ElementNames value
Global element	null	element name	null
Local element	enclosing global type's name or null if there is no enclosing global type	stack of element names identifying the local type (either starts with a global element name if there is no enclosing global type, or with the local element name within the enclosing global type)	null

Since:

9.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
javax.xml.namespace.QName	getElementName() Returns the actual element name of this element identifier.
javax.xml.namespace.QName[]	getElementNames() Returns the element name stack of this XML schema element identifier.
javax.xml.namespace.QName	getGroupName() Returns the name of the model group in which this element is defined.
javax.xml.namespace.QName	getTypeName() Returns the typename that is part of this identifier, or null if this element has no enclosing global type.
int	hashCode()
boolean	isGlobal() Returns true if this identifier represents a global element, false otherwise.
static TLcdXMLSchemaElementIdentifier	newGlobalElementInstance(javax.xml.namespace.QName aGlobalElementName) Returns an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML global schema element.
static TLcdXMLSchemaElementIdentifier	newInstance(javax.xml.namespace.QName aTypeName, javax.xml.namespace.QName[] aElementNames) Returns an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.
static TLcdXMLSchemaElementIdentifier	newInstance(javax.xml.namespace.QName aTypeName, javax.xml.namespace.QName aGroupName, javax.xml.namespace.QName[] aElementNames) Returns an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static TLcdXMLSchemaElementIdentifier newInstance(javax.xml.namespace.QName aTypeName,
                                                         javax.xml.namespace.QName[] aElementNames)

Returns an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.

Parameters:

aTypeName - a global type name

aElementNames - a stack of element names

Returns:

an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.

Throws:

java.lang.NullPointerException - if aElementNames is null.

newInstance

public static TLcdXMLSchemaElementIdentifier newInstance(javax.xml.namespace.QName aTypeName,
                                                         javax.xml.namespace.QName aGroupName,
                                                         javax.xml.namespace.QName[] aElementNames)

Returns an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.

Parameters:

aTypeName - a global type name

aGroupName - a global model group name

aElementNames - a stack of element names

Returns:

an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.

Throws:

java.lang.NullPointerException - if aElementNames is null.

newGlobalElementInstance

public static TLcdXMLSchemaElementIdentifier newGlobalElementInstance(javax.xml.namespace.QName aGlobalElementName)

Returns an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML global schema element.

Parameters:

aGlobalElementName - a global element name

Returns:

an instance of a TLcdXMLSchemaElementIdentifier representing the specified XML schema element.

Throws:

java.lang.NullPointerException - if aGlobalElementName is null.

isGlobal

public boolean isGlobal()

Returns true if this identifier represents a global element, false otherwise.

Returns:

true if this identifier represents a global element, false otherwise.

getElementNames

public javax.xml.namespace.QName[] getElementNames()

Returns the element name stack of this XML schema element identifier.

Returns:

the element name stack of this XML schema element identifier.

getElementName

public javax.xml.namespace.QName getElementName()

Returns the actual element name of this element identifier.

Returns:

the actual element name of this element identifier.

getGroupName

public javax.xml.namespace.QName getGroupName()

Returns the name of the model group in which this element is defined. Returns null if the element is not defined with in a group.

Returns:

the actual group name of this element identifier.

getTypeName

public javax.xml.namespace.QName getTypeName()

Returns the typename that is part of this identifier, or null if this element has no enclosing global type.

Returns:

the typename that is part of this identifier, or null if this element has no enclosing global type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object