/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.impl.xs;

import org.apache.xerces.impl.dv.ValidatedInfo;
import org.apache.xerces.impl.xs.identity.IdentityConstraint;
import org.apache.xerces.impl.xs.util.XSNamedMapImpl;
import org.apache.xerces.impl.xs.util.XSObjectListImpl;
import org.apache.xerces.xni.QName;
import org.apache.xerces.xs.ShortList;
import org.apache.xerces.xs.XSAnnotation;
import org.apache.xerces.xs.XSComplexTypeDefinition;
import org.apache.xerces.xs.XSConstants;
import org.apache.xerces.xs.XSElementDeclaration;
import org.apache.xerces.xs.XSNamedMap;
import org.apache.xerces.xs.XSNamespaceItem;
import org.apache.xerces.xs.XSObjectList;
import org.apache.xerces.xs.XSTypeDefinition;
import org.apache.xerces.xs.XSValue;

The XML representation for an element declaration schema component is an <element> element information item
Author:Elena Litani, IBM, Sandy Gao, IBM
@xerces.internal
Version:$Id: XSElementDecl.java 1024038 2010-10-18 22:06:35Z sandygao $
/** * The XML representation for an element declaration * schema component is an &lt;element&gt; element information item * * @xerces.internal * * @author Elena Litani, IBM * @author Sandy Gao, IBM * @version $Id: XSElementDecl.java 1024038 2010-10-18 22:06:35Z sandygao $ */
public class XSElementDecl implements XSElementDeclaration { // scopes public final static short SCOPE_ABSENT = 0; public final static short SCOPE_GLOBAL = 1; public final static short SCOPE_LOCAL = 2; // name of the element public String fName = null; // target namespace of the element public String fTargetNamespace = null; // type of the element public XSTypeDefinition fType = null; public QName fUnresolvedTypeName = null; // misc flag of the element: nillable/abstract/fixed short fMiscFlags = 0; public short fScope = XSConstants.SCOPE_ABSENT; // enclosing complex type, when the scope is local XSComplexTypeDecl fEnclosingCT = null; // block set (disallowed substitutions) of the element public short fBlock = XSConstants.DERIVATION_NONE; // final set (substitution group exclusions) of the element public short fFinal = XSConstants.DERIVATION_NONE; // optional annotation public XSObjectList fAnnotations = null; // value constraint value public ValidatedInfo fDefault = null; // the substitution group affiliation of the element public XSElementDecl fSubGroup = null; // identity constraints static final int INITIAL_SIZE = 2; int fIDCPos = 0; IdentityConstraint[] fIDConstraints = new IdentityConstraint[INITIAL_SIZE]; // The namespace schema information item corresponding to the target namespace // of the element declaration, if it is globally declared; or null otherwise. private XSNamespaceItem fNamespaceItem = null; private static final short CONSTRAINT_MASK = 3; private static final short NILLABLE = 4; private static final short ABSTRACT = 8; // methods to get/set misc flag public void setConstraintType(short constraintType) { // first clear the bits fMiscFlags ^= (fMiscFlags & CONSTRAINT_MASK); // then set the proper one fMiscFlags |= (constraintType & CONSTRAINT_MASK); } public void setIsNillable() { fMiscFlags |= NILLABLE; } public void setIsAbstract() { fMiscFlags |= ABSTRACT; } public void setIsGlobal() { fScope = SCOPE_GLOBAL; } public void setIsLocal(XSComplexTypeDecl enclosingCT) { fScope = SCOPE_LOCAL; fEnclosingCT = enclosingCT; } public void addIDConstraint(IdentityConstraint idc) { if (fIDCPos == fIDConstraints.length) { fIDConstraints = resize(fIDConstraints, fIDCPos*2); } fIDConstraints[fIDCPos++] = idc; } public IdentityConstraint[] getIDConstraints() { if (fIDCPos == 0) { return null; } if (fIDCPos < fIDConstraints.length) { fIDConstraints = resize(fIDConstraints, fIDCPos); } return fIDConstraints; } static final IdentityConstraint[] resize(IdentityConstraint[] oldArray, int newSize) { IdentityConstraint[] newArray = new IdentityConstraint[newSize]; System.arraycopy(oldArray, 0, newArray, 0, Math.min(oldArray.length, newSize)); return newArray; }
get the string description of this element
/** * get the string description of this element */
private String fDescription = null; public String toString() { if (fDescription == null) { if (fTargetNamespace != null) { StringBuffer buffer = new StringBuffer( fTargetNamespace.length() + ((fName != null) ? fName.length() : 4) + 3); buffer.append('"'); buffer.append(fTargetNamespace); buffer.append('"'); buffer.append(':'); buffer.append(fName); fDescription = buffer.toString(); } else { fDescription = fName; } } return fDescription; }
get the hash code
/** * get the hash code */
public int hashCode() { int code = fName.hashCode(); if (fTargetNamespace != null) code = (code<<16)+fTargetNamespace.hashCode(); return code; }
whether two decls are the same
/** * whether two decls are the same */
public boolean equals(Object o) { return o == this; }
Reset current element declaration
/** * Reset current element declaration */
public void reset(){ fScope = XSConstants.SCOPE_ABSENT; fName = null; fTargetNamespace = null; fType = null; fUnresolvedTypeName = null; fMiscFlags = 0; fBlock = XSConstants.DERIVATION_NONE; fFinal = XSConstants.DERIVATION_NONE; fDefault = null; fAnnotations = null; fSubGroup = null; // reset identity constraints for (int i=0;i<fIDCPos;i++) { fIDConstraints[i] = null; } fIDCPos = 0; }
Get the type of the object, i.e ELEMENT_DECLARATION.
/** * Get the type of the object, i.e ELEMENT_DECLARATION. */
public short getType() { return XSConstants.ELEMENT_DECLARATION; }
The name of this XSObject depending on the XSObject type.
/** * The <code>name</code> of this <code>XSObject</code> depending on the * <code>XSObject</code> type. */
public String getName() { return fName; }
The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.
/** * The namespace URI of this node, or <code>null</code> if it is * unspecified. defines how a namespace URI is attached to schema * components. */
public String getNamespace() { return fTargetNamespace; }
Either a simple type definition or a complex type definition.
/** * Either a simple type definition or a complex type definition. */
public XSTypeDefinition getTypeDefinition() { return fType; }
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.
/** * Optional. Either global or a complex type definition ( * <code>ctDefinition</code>). 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. */
public short getScope() { return fScope; }
Locally scoped declarations are available for use only within the complex type definition identified by the scope property.
/** * Locally scoped declarations are available for use only within the * complex type definition identified by the <code>scope</code> * property. */
public XSComplexTypeDefinition getEnclosingCTDefinition() { return fEnclosingCT; }
A value constraint: one of default, fixed.
/** * A value constraint: one of default, fixed. */
public short getConstraintType() { return (short)(fMiscFlags & CONSTRAINT_MASK); }
A value constraint: The actual value (with respect to the {type definition})
/** * A value constraint: The actual value (with respect to the {type * definition}) */
public String getConstraintValue() { // REVISIT: SCAPI: what's the proper representation return getConstraintType() == XSConstants.VC_NONE ? null : fDefault.stringValue(); }
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.
/** * 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. */
public boolean getNillable() { return ((fMiscFlags & NILLABLE) != 0); }
{identity-constraint definitions} A set of constraint definitions.
/** * {identity-constraint definitions} A set of constraint definitions. */
public XSNamedMap getIdentityConstraints() { return new XSNamedMapImpl(fIDConstraints, fIDCPos); }
{substitution group affiliation} Optional. A top-level element definition.
/** * {substitution group affiliation} Optional. A top-level element * definition. */
public XSElementDeclaration getSubstitutionGroupAffiliation() { return fSubGroup; }
Convenience method. Check if exclusion is a substitution group exclusion for this element declaration.
Params:
  • exclusion – Extension, restriction or none. Represents final set for the element.
Returns:True if exclusion is a part of the substitution group exclusion subset.
/** * Convenience method. Check if <code>exclusion</code> is a substitution * group exclusion for this element declaration. * @param exclusion Extension, restriction or none. Represents final * set for the element. * @return True if <code>exclusion</code> is a part of the substitution * group exclusion subset. */
public boolean isSubstitutionGroupExclusion(short exclusion) { return (fFinal & exclusion) != 0; }
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.
Returns:A bit flag representing {extension, restriction} or NONE.
/** * 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. * * @return A bit flag representing {extension, restriction} or NONE. */
public short getSubstitutionGroupExclusions() { return fFinal; }
Convenience method. Check if disallowed is a disallowed substitution for this element declaration.
Params:
  • 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.
/** * Convenience method. Check if <code>disallowed</code> is a disallowed * substitution for this element declaration. * @param disallowed Substitution, extension, restriction or none. * Represents a block set for the element. * @return True if <code>disallowed</code> is a part of the substitution * group exclusion subset. */
public boolean isDisallowedSubstitution(short disallowed) { return (fBlock & disallowed) != 0; }
The supplied values for {disallowed substitutions}
Returns:A bit flag representing {substitution, extension, restriction} or NONE.
/** * The supplied values for {disallowed substitutions} * * @return A bit flag representing {substitution, extension, restriction} or NONE. */
public short getDisallowedSubstitutions() { return fBlock; }
{abstract} A boolean.
/** * {abstract} A boolean. */
public boolean getAbstract() { return ((fMiscFlags & ABSTRACT) != 0); }
Optional. Annotation.
/** * Optional. Annotation. */
public XSAnnotation getAnnotation() { return (fAnnotations != null) ? (XSAnnotation) fAnnotations.item(0) : null; }
Optional. Annotations.
/** * Optional. Annotations. */
public XSObjectList getAnnotations() { return (fAnnotations != null) ? fAnnotations : XSObjectListImpl.EMPTY_LIST; }
See Also:
  • getNamespaceItem.getNamespaceItem()
/** * @see org.apache.xerces.xs.XSObject#getNamespaceItem() */
public XSNamespaceItem getNamespaceItem() { return fNamespaceItem; } void setNamespaceItem(XSNamespaceItem namespaceItem) { fNamespaceItem = namespaceItem; } public Object getActualVC() { return getConstraintType() == XSConstants.VC_NONE ? null : fDefault.actualValue; } public short getActualVCType() { return getConstraintType() == XSConstants.VC_NONE ? XSConstants.UNAVAILABLE_DT : fDefault.actualValueType; } public ShortList getItemValueTypes() { return getConstraintType() == XSConstants.VC_NONE ? null : fDefault.itemValueTypes; } public XSValue getValueConstraintValue() { return fDefault; } } // class XSElementDecl