org.apache.xerces.impl.xs

Class XSElementDecl

Implemented Interfaces:
org.apache.xerces.xs.XSElementDeclaration

public class XSElementDecl
extends java.lang.Object
implements org.apache.xerces.xs.XSElementDeclaration

The XML representation for an element declaration schema component is an element information item
Version:
$Id: XSElementDecl.java,v 1.19 2004/12/07 18:11:27 sandygao Exp $
Authors:
Elena Litani, IBM
Sandy Gao, IBM

Field Summary

static short
SCOPE_ABSENT
static short
SCOPE_GLOBAL
static short
SCOPE_LOCAL
XSAnnotationImpl
fAnnotation
short
fBlock
ValidatedInfo
fDefault
short
fFinal
String
fName
short
fScope
XSElementDecl
fSubGroup
String
fTargetNamespace
org.apache.xerces.xs.XSTypeDefinition
fType

Method Summary

void
addIDConstraint(IdentityConstraint idc)
boolean
equals(Object o)
whether two decls are the same
boolean
getAbstract()
{abstract} A boolean.
Object
getActualVC()
short
getActualVCType()
org.apache.xerces.xs.XSAnnotation
getAnnotation()
Optional.
short
getConstraintType()
A value constraint: one of default, fixed.
String
getConstraintValue()
A value constraint: The actual value (with respect to the {type definition})
short
getDisallowedSubstitutions()
The supplied values for {disallowed substitutions}
org.apache.xerces.xs.XSComplexTypeDefinition
getEnclosingCTDefinition()
Locally scoped declarations are available for use only within the complex type definition identified by the scope property.
IdentityConstraint[]
getIDConstraints()
org.apache.xerces.xs.XSNamedMap
getIdentityConstraints()
{identity-constraint definitions} A set of constraint definitions.
org.apache.xerces.xs.ShortList
getItemValueTypes()
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.
org.apache.xerces.xs.XSNamespaceItem
getNamespaceItem()
boolean
getNillable()
If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.
short
getScope()
Optional.
org.apache.xerces.xs.XSElementDeclaration
getSubstitutionGroupAffiliation()
{substitution group affiliation} Optional.
short
getSubstitutionGroupExclusions()
Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.
short
getType()
Get the type of the object, i.e ELEMENT_DECLARATION.
org.apache.xerces.xs.XSTypeDefinition
getTypeDefinition()
Either a simple type definition or a complex type definition.
int
hashCode()
get the hash code
boolean
isDisallowedSubstitution(short disallowed)
Convenience method.
boolean
isSubstitutionGroupExclusion(short exclusion)
Convenience method.
void
reset()
Reset current element declaration
void
setConstraintType(short constraintType)
void
setIsAbstract()
void
setIsGlobal()
void
setIsLocal(XSComplexTypeDecl enclosingCT)
void
setIsNillable()
String
toString()

Field Details

SCOPE_ABSENT

public static final short SCOPE_ABSENT
Field Value:
0

SCOPE_GLOBAL

public static final short SCOPE_GLOBAL
Field Value:
1

SCOPE_LOCAL

public static final short SCOPE_LOCAL
Field Value:
2

fAnnotation

public XSAnnotationImpl fAnnotation

fBlock

public short fBlock

fDefault

public ValidatedInfo fDefault

fFinal

public short fFinal

fName

public String fName

fScope

public short fScope

fSubGroup

public XSElementDecl fSubGroup

fTargetNamespace

public String fTargetNamespace

fType

public org.apache.xerces.xs.XSTypeDefinition fType

Method Details

addIDConstraint

public void addIDConstraint(IdentityConstraint idc)

equals

public boolean equals(Object o)
whether two decls are the same

getAbstract

public boolean getAbstract()
{abstract} A boolean.
Specified by:
getAbstract in interface org.apache.xerces.xs.XSElementDeclaration

getActualVC

public Object getActualVC()
Specified by:
getActualVC in interface org.apache.xerces.xs.XSElementDeclaration

getActualVCType

public short getActualVCType()
Specified by:
getActualVCType in interface org.apache.xerces.xs.XSElementDeclaration

getAnnotation

public org.apache.xerces.xs.XSAnnotation getAnnotation()
Optional. Annotation.
Specified by:
getAnnotation in interface org.apache.xerces.xs.XSElementDeclaration

getConstraintType

public short getConstraintType()
A value constraint: one of default, fixed.
Specified by:
getConstraintType in interface org.apache.xerces.xs.XSElementDeclaration

getConstraintValue

public String getConstraintValue()
A value constraint: The actual value (with respect to the {type definition})
Specified by:
getConstraintValue in interface org.apache.xerces.xs.XSElementDeclaration

getDisallowedSubstitutions

public short getDisallowedSubstitutions()
The supplied values for {disallowed substitutions}
Specified by:
getDisallowedSubstitutions in interface org.apache.xerces.xs.XSElementDeclaration
Returns:
A bit flag representing {substitution, extension, restriction} or NONE.

getEnclosingCTDefinition

public org.apache.xerces.xs.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 org.apache.xerces.xs.XSElementDeclaration

getIDConstraints

public IdentityConstraint[] getIDConstraints()

getIdentityConstraints

public org.apache.xerces.xs.XSNamedMap getIdentityConstraints()
{identity-constraint definitions} A set of constraint definitions.
Specified by:
getIdentityConstraints in interface org.apache.xerces.xs.XSElementDeclaration

getItemValueTypes

public org.apache.xerces.xs.ShortList getItemValueTypes()
Specified by:
getItemValueTypes in interface org.apache.xerces.xs.XSElementDeclaration

getName

public String getName()
The name of this XSObject depending on the XSObject type.
Specified by:
getName in interface org.apache.xerces.xs.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 org.apache.xerces.xs.XSObject

getNamespaceItem

public org.apache.xerces.xs.XSNamespaceItem getNamespaceItem()
Specified by:
getNamespaceItem in interface org.apache.xerces.xs.XSObject
See Also:
org.apache.xerces.xs.XSObject.getNamespaceItem()

getNillable

public boolean getNillable()
If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.
Specified by:
getNillable in interface org.apache.xerces.xs.XSElementDeclaration

getScope

public short getScope()
Optional. Either global or a complex type definition ( ctDefinition). This property is absent in the case of declarations within named model groups: their scope will be determined when they are used in the construction of complex type definitions.
Specified by:
getScope in interface org.apache.xerces.xs.XSElementDeclaration

getSubstitutionGroupAffiliation

public org.apache.xerces.xs.XSElementDeclaration getSubstitutionGroupAffiliation()
{substitution group affiliation} Optional. A top-level element definition.
Specified by:
getSubstitutionGroupAffiliation in interface org.apache.xerces.xs.XSElementDeclaration

getSubstitutionGroupExclusions

public short getSubstitutionGroupExclusions()
Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.
Specified by:
getSubstitutionGroupExclusions in interface org.apache.xerces.xs.XSElementDeclaration
Returns:
A bit flag representing {extension, restriction} or NONE.

getType

public short getType()
Get the type of the object, i.e ELEMENT_DECLARATION.
Specified by:
getType in interface org.apache.xerces.xs.XSObject

getTypeDefinition

public org.apache.xerces.xs.XSTypeDefinition getTypeDefinition()
Either a simple type definition or a complex type definition.
Specified by:
getTypeDefinition in interface org.apache.xerces.xs.XSElementDeclaration

hashCode

public int hashCode()
get the hash code

isDisallowedSubstitution

public boolean isDisallowedSubstitution(short disallowed)
Convenience method. Check if disallowed is a disallowed substitution for this element declaration.
Specified by:
isDisallowedSubstitution in interface org.apache.xerces.xs.XSElementDeclaration
Parameters:
disallowed - Substitution, extension, restriction or none. Represents a block set for the element.
Returns:
True if disallowed is a part of the substitution group exclusion subset.

isSubstitutionGroupExclusion

public boolean isSubstitutionGroupExclusion(short exclusion)
Convenience method. Check if exclusion is a substitution group exclusion for this element declaration.
Specified by:
isSubstitutionGroupExclusion in interface org.apache.xerces.xs.XSElementDeclaration
Parameters:
exclusion - Extension, restriction or none. Represents final set for the element.
Returns:
True if exclusion is a part of the substitution group exclusion subset.

reset

public void reset()
Reset current element declaration

setConstraintType

public void setConstraintType(short constraintType)

setIsAbstract

public void setIsAbstract()

setIsGlobal

public void setIsGlobal()

setIsLocal

public void setIsLocal(XSComplexTypeDecl enclosingCT)

setIsNillable

public void setIsNillable()

toString

public String toString()

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.