/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2003, International
* Business Machines, Inc., http://www.apache.org. For more
* information on the Apache Software Foundation, please see
* .
*/
package com.sun.org.apache.xerces.internal.xs;
/**
* The interface represents the Element Declaration schema component.
*/
public interface XSElementDeclaration extends XSTerm {
/**
* [type definition]: either a simple type definition or a complex type
* definition.
*/
public XSTypeDefinition getTypeDefinition();
/**
* [scope]. One of SCOPE_GLOBAL, SCOPE_LOCAL, or
* SCOPE_ABSENT. If the scope is local, then the
* enclosingCTDefinition is present.
*/
public short getScope();
/**
* The complex type definition for locally scoped declarations (see
* scope), otherwise null if no such
* definition exists.
*/
public XSComplexTypeDefinition getEnclosingCTDefinition();
/**
* [Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.
*/
public short getConstraintType();
/**
* [Value constraint]: the constraint value with respect to the [type
* definition], otherwise null.
*/
public String getConstraintValue();
/**
* 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 Object getActualVC()
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 actualNormalizedValue
* is null, this method returns UNAVAILABLE_DT
* .
* @exception XSException
* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
* method.
*/
public short getActualVCType()
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.
* @exception XSException
* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
* method.
*/
public ShortList getItemValueTypes()
throws XSException;
/**
* 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 boolean getNillable();
/**
* identity-constraint definitions: a set of constraint definitions if it
* exists, otherwise an empty XSNamedMap.
*/
public XSNamedMap getIdentityConstraints();
/**
* [substitution group affiliation]: a top-level element definition if it
* exists, otherwise null.
*/
public XSElementDeclaration getSubstitutionGroupAffiliation();
/**
* 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.
*/
public boolean isSubstitutionGroupExclusion(short exclusion);
/**
* [substitution group exclusions]: the returned value is a bit
* combination of the subset of {
* DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or
* DERIVATION_NONE.
*/
public short getSubstitutionGroupExclusions();
/**
* 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 boolean isDisallowedSubstitution(short disallowed);
/**
* [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 short getDisallowedSubstitutions();
/**
* {abstract} A boolean.
*/
public boolean getAbstract();
/**
* An annotation if it exists, otherwise null.
*/
public XSAnnotation getAnnotation();
}