org.apache.xerces.xs

Interface XSAttributeDeclaration

All Superinterfaces:

XSObject

All Known Implementing Classes:

XSAttributeDecl

public interface XSAttributeDeclaration
extends XSObject

The interface represents the Attribute Declaration schema component.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getActualVC() Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.
short	getActualVCType() The actual constraint value built-in datatype, e.g.
XSAnnotation	getAnnotation() An annotation if it exists, otherwise null.
XSObjectList	getAnnotations() A sequence of [annotations] or an empty XSObjectList.
short	getConstraintType() Value constraint: one of VC_NONE, VC_DEFAULT, VC_FIXED.
String	getConstraintValue() Value constraint: The constraint value with respect to the [type definition], otherwise null.
XSComplexTypeDefinition	getEnclosingCTDefinition() The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.
ShortList	getItemValueTypes() In the case the actual constraint value represents a list, i.e.
short	getScope() [scope].
XSSimpleTypeDefinition	getTypeDefinition() [type definition]: A simple type definition.

Methods inherited from interface org.apache.xerces.xs.XSObject

getName, getNamespace, getNamespaceItem, getType

Method Detail

getTypeDefinition

XSSimpleTypeDefinition getTypeDefinition()

[type definition]: A simple type definition.

getScope

short getScope()

[scope]. One of SCOPE_GLOBAL, SCOPE_LOCAL, or SCOPE_ABSENT. If the scope is local, then the enclosingCTDefinition is present.

getEnclosingCTDefinition

XSComplexTypeDefinition getEnclosingCTDefinition()

The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.

getConstraintType

short getConstraintType()

Value constraint: one of VC_NONE, VC_DEFAULT, VC_FIXED.

getConstraintValue

String getConstraintValue()

Value constraint: The constraint value with respect to the [type definition], otherwise null.

getActualVC

Object getActualVC()
                   throws XSException

Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.

Throws:

XSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

getActualVCType

short getActualVCType()
                      throws XSException

The actual constraint value built-in datatype, e.g. STRING_DT, SHORT_DT. If the type definition of this value is a list type definition, this method returns LIST_DT. If the type definition of this value is a list type definition whose item type is a union type definition, this method returns LISTOFUNION_DT. To query the actual constraint value of the list or list of union type definitions use itemValueTypes. If the actualValue is null, this method returns UNAVAILABLE_DT.

Throws:

XSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

getItemValueTypes

ShortList getItemValueTypes()
                            throws XSException

In the case the actual constraint value represents a list, i.e. the actualValueType is LIST_DT, the returned array consists of one type kind which represents the itemType. If the actual constraint value represents a list type definition whose item type is a union type definition, i.e. LISTOFUNION_DT, for each actual constraint value in the list the array contains the corresponding memberType kind. For examples, see ItemPSVI.itemValueTypes.

Throws:

XSException - NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

getAnnotation

XSAnnotation getAnnotation()

An annotation if it exists, otherwise null. If not null then the first [annotation] from the sequence of annotations.

getAnnotations

XSObjectList getAnnotations()

A sequence of [annotations] or an empty XSObjectList.