org.apache.xerces.xs.ItemPSVI Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation
Show all versions of xercesImpl Show documentation
Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family.
This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building
parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is
the reference implementation of XNI but other parser components, configurations, and parsers can be written
using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual.
Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema
1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema
Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for
evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation
of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete
implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML
Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that
it does not yet provide an option to enable normalization checking as described in section 2.13 of this
specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly
serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.
The newest version!
/*
* 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.xs;
/**
* Represents an abstract PSVI item for an element or an attribute
* information item.
*/
public interface ItemPSVI {
/**
* Validity value indicating that validation has either not been performed
* or that a strict assessment of validity could not be performed.
*/
public static final short VALIDITY_NOTKNOWN = 0;
/**
* Validity value indicating that validation has been strictly assessed
* and the item in question is invalid according to the rules of schema
* validation.
*/
public static final short VALIDITY_INVALID = 1;
/**
* Validation status indicating that schema validation has been performed
* and the item in question is valid according to the rules of schema
* validation.
*/
public static final short VALIDITY_VALID = 2;
/**
* Validation status indicating that schema validation has been performed
* and the item in question has specifically been skipped.
*/
public static final short VALIDATION_NONE = 0;
/**
* Validation status indicating that schema validation has been performed
* on the item in question under the rules of lax validation.
*/
public static final short VALIDATION_PARTIAL = 1;
/**
* Validation status indicating that full schema validation has been
* performed on the item.
*/
public static final short VALIDATION_FULL = 2;
/**
* Returns a reference to an immutable instance with the same data
* that this instance of ItemPSVI currently has.
*/
public ItemPSVI constant();
/**
* Returns true if this specific instance of
* ItemPSVI is immutable, otherwise false.
*/
public boolean isConstant();
/**
* The nearest ancestor element information item with a
* [schema information] property (or this element item
* itself if it has such a property). For more information refer to
* element validation context and attribute validation context .
*/
public String getValidationContext();
/**
* [validity]: determines the validity of the schema item
* with respect to the validation being attempted. The value will be one
* of the constants: VALIDITY_NOTKNOWN,
* VALIDITY_INVALID or VALIDITY_VALID.
*/
public short getValidity();
/**
* [validation attempted]: determines the extent to which
* the schema item has been validated. The value will be one of the
* constants: VALIDATION_NONE,
* VALIDATION_PARTIAL or VALIDATION_FULL.
*/
public short getValidationAttempted();
/**
* [schema error code]: a list of error codes generated from
* the validation attempt or an empty StringList if no
* errors occurred during the validation attempt.
*/
public StringList getErrorCodes();
/**
* A list of error messages generated from the validation attempt or
* an empty StringList if no errors occurred during the
* validation attempt. The indices of error messages in this list are
* aligned with those in the [schema error code] list.
*/
public StringList getErrorMessages();
/**
* [schema normalized value]: the normalized value of this
* item after validation.
*
* @deprecated Use getSchemaValue().getNormalizedValue() instead
*/
public String getSchemaNormalizedValue();
/**
* [schema normalized value]: Binding specific actual value
* or null if the value is in error.
* @exception XSException
* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
* method.
*
* @deprecated Use getSchemaValue().getActualValue() instead
*/
public Object getActualNormalizedValue()
throws XSException;
/**
* The actual 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 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.
*
* @deprecated Use getSchemaValue().getActualValueType() instead
*/
public short getActualNormalizedValueType()
throws XSException;
/**
* In the case the actual value represents a list, i.e. the
* actualNormalizedValueType is LIST_DT, the
* returned array consists of one type kind which represents the itemType
* . For example:
* <simpleType name="listtype"> <list
* itemType="positiveInteger"/> </simpleType> <element
* name="list" type="listtype"/> ... <list>1 2 3</list>
*
* The schemaNormalizedValue value is "1 2 3", the
* actualNormalizedValueType value is LIST_DT,
* and the itemValueTypes is an array of size 1 with the
* value POSITIVEINTEGER_DT.
*
If the actual value represents a list type definition whose item
* type is a union type definition, i.e. LISTOFUNION_DT,
* for each actual value in the list the array contains the
* corresponding memberType kind. For example:
* <simpleType
* name='union_type' memberTypes="integer string"/> <simpleType
* name='listOfUnion'> <list itemType='union_type'/>
* </simpleType> <element name="list" type="listOfUnion"/>
* ... <list>1 2 foo</list>
* The
* schemaNormalizedValue value is "1 2 foo", the
* actualNormalizedValueType is LISTOFUNION_DT
* , and the itemValueTypes is an array of size 3 with the
* following values: INTEGER_DT, INTEGER_DT, STRING_DT.
* @exception XSException
* NOT_SUPPORTED_ERR: Raised if the implementation does not support this
* method.
*
* @deprecated Use getSchemaValue().getListValueTypes() instead
*/
public ShortList getItemValueTypes()
throws XSException;
/**
* If this item has a simple type definition or a complex type with simple
* content, then return the value with respect to the simple type. If
* this item doesn't have a simple-typed value, the behavior of this method
* is not specified.
*/
public XSValue getSchemaValue();
/**
* [type definition]: an item isomorphic to the type
* definition used to validate the schema item.
*/
public XSTypeDefinition getTypeDefinition();
/**
* [member type definition]: if and only if that type
* definition is a simple type definition with {variety} union, or a
* complex type definition whose {content type} is a simple type
* definition with {variety} union, then an item isomorphic to that
* member of the union's {member type definitions} which actually
* validated the schema item's normalized value.
*/
public XSSimpleTypeDefinition getMemberTypeDefinition();
/**
* [schema default]: the canonical lexical representation of
* the declaration's {value constraint} value. For more information
* refer to element schema default and attribute schema default.
*/
public String getSchemaDefault();
/**
* [schema specified]: if true, the value was specified in
* the schema. If false, the value comes from the infoset. For more
* information refer to element specified and attribute specified.
*/
public boolean getIsSchemaSpecified();
}