Back to index...

	/*
	* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
	*/
	/*
	* 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 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 <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
	* <code>SCOPE_ABSENT</code>. If the scope is local, then the
	* <code>enclosingCTDefinition</code> is present.
	*/
	public short getScope();

	/**
	* The complex type definition for locally scoped declarations (see
	* <code>scope</code>), otherwise <code>null</code> if no such
	* definition exists.
	*/
	public XSComplexTypeDefinition getEnclosingCTDefinition();

	/**
	* [Value constraint]: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
	*/
	public short getConstraintType();

	/**
	* [Value constraint]: the constraint value with respect to the [type
	* definition], otherwise <code>null</code>.
	*
	* @deprecated Use getValueConstraintValue().getNormalizedValue() instead
	*/
	@Deprecated
	public String getConstraintValue();

	/**
	* Value Constraint: Binding specific actual constraint value or
	* <code>null</code> 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.
	*
	* @deprecated Use getValueConstraintValue().getActualValue() instead
	*/
	@Deprecated
	public Object getActualVC()
	throws XSException;

	/**
	* The actual constraint value built-in datatype, e.g.
	* <code>STRING_DT, SHORT_DT</code>. If the type definition of this
	* value is a list type definition, this method returns
	* <code>LIST_DT</code>. If the type definition of this value is a list
	* type definition whose item type is a union type definition, this
	* method returns <code>LISTOFUNION_DT</code>. To query the actual
	* constraint value of the list or list of union type definitions use
	* <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
	* is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
	* @exception XSException
	* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
	* method.
	*
	* @deprecated Use getValueConstraintValue().getActualValueType() instead
	*/
	@Deprecated
	public short getActualVCType()
	throws XSException;

	/**
	* In the case the actual constraint value represents a list, i.e. the
	* <code>actualValueType</code> is <code>LIST_DT</code>, 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. <code>LISTOFUNION_DT</code>,
	* for each actual constraint value in the list the array contains the
	* corresponding memberType kind. For examples, see
	* <code>ItemPSVI.itemValueTypes</code>.
	* @exception XSException
	* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
	* method.
	*
	* @deprecated Use getValueConstraintValue().getListValueTypes() instead
	*/
	@Deprecated
	public ShortList getItemValueTypes()
	throws XSException;

	/**
	* The actual value of the default or fixed value constraint.
	*/
	public XSValue getValueConstraintValue();

	/**
	* If nillable is true, then an element may also be valid if it carries
	* the namespace qualified attribute with local name <code>nil</code>
	* from namespace <code>http://www.w3.org/2001/XMLSchema-instance</code>
	* and value <code>true</code> (xsi:nil) even if it has no text or
	* element content despite a <code>content type</code> which would
	* otherwise require content.
	*/
	public boolean getNillable();

	/**
	* identity-constraint definitions: a set of constraint definitions if it
	* exists, otherwise an empty <code>XSNamedMap</code>.
	*/
	public XSNamedMap getIdentityConstraints();

	/**
	* [substitution group affiliation]: a top-level element definition if it
	* exists, otherwise <code>null</code>.
	*/
	public XSElementDeclaration getSubstitutionGroupAffiliation();

	/**
	* Convenience method that checks if <code>exclusion</code> is a
	* substitution group exclusion for this element declaration.
	* @param exclusion
	* <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code> or
	* <code>DERIVATION_NONE</code>. 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);

	/**
	* [substitution group exclusions]: the returned value is a bit
	* combination of the subset of {
	* <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>} or
	* <code>DERIVATION_NONE</code>.
	*/
	public short getSubstitutionGroupExclusions();

	/**
	* Convenience method that checks if <code>disallowed</code> is a
	* disallowed substitution for this element declaration.
	* @param disallowed {
	* <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>
	* } or <code>DERIVATION_NONE</code>. 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);

	/**
	* [disallowed substitutions]: the returned value is a bit combination of
	* the subset of {
	* <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>
	* } corresponding to substitutions disallowed by this
	* <code>XSElementDeclaration</code> or <code>DERIVATION_NONE</code>.
	*/
	public short getDisallowedSubstitutions();

	/**
	* {abstract} A boolean.
	*/
	public boolean getAbstract();

	/**
	* An annotation if it exists, otherwise <code>null</code>. If not null
	* then the first [annotation] from the sequence of annotations.
	*/
	public XSAnnotation getAnnotation();

	/**
	* A sequence of [annotations] or an empty <code>XSObjectList</code>.
	*/
	public XSObjectList getAnnotations();
	}

Back to index...