org.apache.xerces.impl.xs.XSAttributeUseImpl 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.
/*
* 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.util.XSObjectListImpl;
import org.apache.xerces.xs.ShortList;
import org.apache.xerces.xs.XSAttributeDeclaration;
import org.apache.xerces.xs.XSAttributeUse;
import org.apache.xerces.xs.XSConstants;
import org.apache.xerces.xs.XSNamespaceItem;
import org.apache.xerces.xs.XSObjectList;
import org.apache.xerces.xs.XSValue;
/**
* The XML representation for an attribute use
* schema component is a local <attribute> element information item
*
* @xerces.internal
*
* @author Sandy Gao, IBM
* @version $Id: XSAttributeUseImpl.java 1024038 2010-10-18 22:06:35Z sandygao $
*/
public class XSAttributeUseImpl implements XSAttributeUse {
// the referred attribute decl
public XSAttributeDecl fAttrDecl = null;
// use information: SchemaSymbols.USE_OPTIONAL, REQUIRED, PROHIBITED
public short fUse = SchemaSymbols.USE_OPTIONAL;
// value constraint type: default, fixed or !specified
public short fConstraintType = XSConstants.VC_NONE;
// value constraint value
public ValidatedInfo fDefault = null;
// optional annotation
public XSObjectList fAnnotations = null;
public void reset(){
fDefault = null;
fAttrDecl = null;
fUse = SchemaSymbols.USE_OPTIONAL;
fConstraintType = XSConstants.VC_NONE;
fAnnotations = null;
}
/**
* Get the type of the object, i.e ELEMENT_DECLARATION.
*/
public short getType() {
return XSConstants.ATTRIBUTE_USE;
}
/**
* The name of this XSObject depending on the
* XSObject type.
*/
public String getName() {
return null;
}
/**
* The namespace URI of this node, or null if it is
* unspecified. defines how a namespace URI is attached to schema
* components.
*/
public String getNamespace() {
return null;
}
/**
* {required} determines whether this use of an attribute declaration
* requires an appropriate attribute information item to be present, or
* merely allows it.
*/
public boolean getRequired() {
return fUse == SchemaSymbols.USE_REQUIRED;
}
/**
* {attribute declaration} provides the attribute declaration itself,
* which will in turn determine the simple type definition used.
*/
public XSAttributeDeclaration getAttrDeclaration() {
return fAttrDecl;
}
/**
* Value Constraint: one of default, fixed.
*/
public short getConstraintType() {
return fConstraintType;
}
/**
* 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();
}
/**
* @see org.apache.xerces.xs.XSObject#getNamespaceItem()
*/
public XSNamespaceItem getNamespaceItem() {
return null;
}
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;
}
/**
* Optional. Annotations.
*/
public XSObjectList getAnnotations() {
return (fAnnotations != null) ? fAnnotations : XSObjectListImpl.EMPTY_LIST;
}
} // class XSAttributeUseImpl