org.apache.xerces.impl.xs

Class XSAttributeDecl

java.lang.Object

org.apache.xerces.impl.xs.XSAttributeDecl

All Implemented Interfaces:

XSAttributeDeclaration, XSObject

public class XSAttributeDecl
extends Object
implements XSAttributeDeclaration

The XML representation for an attribute declaration schema component is an <attribute> element information item

Version:

$Id$

Author:

Elena Litani, IBM, Sandy Gao, IBM

Field Summary

Fields

Modifier and Type	Field and Description
QName	fUnresolvedTypeName
static short	SCOPE_ABSENT
static short	SCOPE_GLOBAL
static short	SCOPE_LOCAL

Constructor Summary

Constructors

Constructor and Description
XSAttributeDecl()

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() Optional.
XSObjectList	getAnnotations() Optional.
short	getConstraintType() Value constraint: one of default, fixed.
String	getConstraintValue() Value constraint: The actual value (with respect to the {type definition}) Should we return Object instead of DOMString?
XSComplexTypeDefinition	getEnclosingCTDefinition() Locally scoped declarations are available for use only within the complex type definition identified by the scope property.
boolean	getInheritable() Inheritable flag for the attribute.
ShortList	getItemValueTypes() In the case the actual constraint value represents a list, i.e.
String	getName() The name of this XSObject depending on the XSObject type.
String	getNamespace() The namespace URI of this node, or null if it is unspecified.
XSNamespaceItem	getNamespaceItem() A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.
XSObject	getParent() Locally scoped declarations are available for use only within the complex type definition or attribute group definition identified by the scope property.
short	getScope() Optional.
short	getType() Get the type of the object, i.e ELEMENT_DECLARATION.
XSSimpleTypeDefinition	getTypeDefinition() A simple type definition
ValidatedInfo	getValInfo()
XSValue	getValueConstraintValue() The actual value of the default or fixed value constraint.
void	reset()
void	setValues(String name, String targetNamespace, XSSimpleType simpleType, short constraintType, short scope, ValidatedInfo valInfo, XSObject enclosingParent, XSObjectList annotations, boolean inheritable)

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_ABSENT

public static final short SCOPE_ABSENT

See Also:

Constant Field Values

SCOPE_GLOBAL

public static final short SCOPE_GLOBAL

See Also:

Constant Field Values

SCOPE_LOCAL

public static final short SCOPE_LOCAL

See Also:

Constant Field Values

fUnresolvedTypeName

public QName fUnresolvedTypeName

Constructor Detail

XSAttributeDecl

public XSAttributeDecl()

Method Detail

setValues

public void setValues(String name,
             String targetNamespace,
             XSSimpleType simpleType,
             short constraintType,
             short scope,
             ValidatedInfo valInfo,
             XSObject enclosingParent,
             XSObjectList annotations,
             boolean inheritable)

reset

public void reset()

getType

public short getType()

Get the type of the object, i.e ELEMENT_DECLARATION.

Specified by:

getType in interface XSObject

getName

public String getName()

The name of this XSObject depending on the XSObject type.

Specified by:

getName in interface XSObject

getNamespace

public String getNamespace()

The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.

Specified by:

getNamespace in interface XSObject

getTypeDefinition

public XSSimpleTypeDefinition getTypeDefinition()

A simple type definition

Specified by:

getTypeDefinition in interface XSAttributeDeclaration

getScope

public short getScope()

Optional. Either global or a complex type definition ( ctDefinition). This property is absent in the case of declarations within attribute group definitions: their scope will be determined when they are used in the construction of complex type definitions.

Specified by:

getScope in interface XSAttributeDeclaration

getEnclosingCTDefinition

public XSComplexTypeDefinition getEnclosingCTDefinition()

Locally scoped declarations are available for use only within the complex type definition identified by the scope property.

Specified by:

getEnclosingCTDefinition in interface XSAttributeDeclaration

getParent

public XSObject getParent()

Locally scoped declarations are available for use only within the complex type definition or attribute group definition identified by the scope property.

Specified by:

getParent in interface XSAttributeDeclaration

getConstraintType

public short getConstraintType()

Value constraint: one of default, fixed.

Specified by:

getConstraintType in interface XSAttributeDeclaration

getConstraintValue

public String getConstraintValue()

Value constraint: The actual value (with respect to the {type definition}) Should we return Object instead of DOMString?

Specified by:

getConstraintValue in interface XSAttributeDeclaration

getAnnotation

public XSAnnotation getAnnotation()

Optional. Annotation.

Specified by:

getAnnotation in interface XSAttributeDeclaration

getAnnotations

public XSObjectList getAnnotations()

Optional. Annotations.

Specified by:

getAnnotations in interface XSAttributeDeclaration

getValInfo

public ValidatedInfo getValInfo()

getNamespaceItem

public XSNamespaceItem getNamespaceItem()

Description copied from interface: XSObject

A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.

Specified by:

getNamespaceItem in interface XSObject

See Also:

XSObject.getNamespaceItem()

getActualVC

public Object getActualVC()

Description copied from interface: XSAttributeDeclaration

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

Specified by:

getActualVC in interface XSAttributeDeclaration

getActualVCType

public short getActualVCType()

Description copied from interface: XSAttributeDeclaration

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.

Specified by:

getActualVCType in interface XSAttributeDeclaration

getItemValueTypes

public ShortList getItemValueTypes()

Description copied from interface: XSAttributeDeclaration

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.

Specified by:

getItemValueTypes in interface XSAttributeDeclaration

getValueConstraintValue

public XSValue getValueConstraintValue()

Description copied from interface: XSAttributeDeclaration

The actual value of the default or fixed value constraint.

Specified by:

getValueConstraintValue in interface XSAttributeDeclaration

getInheritable

public boolean getInheritable()

Description copied from interface: XSAttributeDeclaration

Inheritable flag for the attribute.

Specified by:

getInheritable in interface XSAttributeDeclaration