FileDocCategorySizeDatePackage
XSElementDeclaration.javaAPI DocJava SE 6 API6691Tue Jun 10 00:22:54 BST 2008com.sun.org.apache.xerces.internal.xs

XSElementDeclaration

public interface XSElementDeclaration implements XSTerm
The interface represents the Element Declaration schema component.

Fields Summary
Constructors Summary
Methods Summary
public booleangetAbstract()
{abstract} A boolean.

public java.lang.ObjectgetActualVC()
Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.

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

public shortgetActualVCType()
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 actualNormalizedValue is null, this method returns UNAVAILABLE_DT .

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

public com.sun.org.apache.xerces.internal.xs.XSAnnotationgetAnnotation()
An annotation if it exists, otherwise null.

public shortgetConstraintType()
[Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.

public java.lang.StringgetConstraintValue()
[Value constraint]: the constraint value with respect to the [type definition], otherwise null.

public shortgetDisallowedSubstitutions()
[disallowed substitutions]: the returned value is a bit combination of the subset of { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION } corresponding to substitutions disallowed by this XSElementDeclaration or DERIVATION_NONE.

public com.sun.org.apache.xerces.internal.xs.XSComplexTypeDefinitiongetEnclosingCTDefinition()
The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.

public com.sun.org.apache.xerces.internal.xs.XSNamedMapgetIdentityConstraints()
identity-constraint definitions: a set of constraint definitions if it exists, otherwise an empty XSNamedMap.

public com.sun.org.apache.xerces.internal.xs.ShortListgetItemValueTypes()
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.

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

public booleangetNillable()
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 (xsi:nil) even if it has no text or element content despite a content type which would otherwise require content.

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

public com.sun.org.apache.xerces.internal.xs.XSElementDeclarationgetSubstitutionGroupAffiliation()
[substitution group affiliation]: a top-level element definition if it exists, otherwise null.

public shortgetSubstitutionGroupExclusions()
[substitution group exclusions]: the returned value is a bit combination of the subset of { DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or DERIVATION_NONE.

public com.sun.org.apache.xerces.internal.xs.XSTypeDefinitiongetTypeDefinition()
[type definition]: either a simple type definition or a complex type definition.

public booleanisDisallowedSubstitution(short disallowed)
Convenience method that checks if disallowed is a disallowed substitution for this element declaration.

param
disallowed { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION } or DERIVATION_NONE. Represents a block set for the element.
return
True if disallowed is a part of the substitution group exclusion subset.

public booleanisSubstitutionGroupExclusion(short exclusion)
Convenience method that checks if exclusion is a substitution group exclusion for this element declaration.

param
exclusion DERIVATION_EXTENSION, DERIVATION_RESTRICTION or DERIVATION_NONE. Represents final set for the element.
return
True if exclusion is a part of the substitution group exclusion subset.