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 xerces2-xsd11 Show documentation
Show all versions of xerces2-xsd11 Show documentation
A processor for parsing, validating, serializing and manipulating XML, written in Java
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.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$
*/
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;
// inheritable attribute flag
public boolean fInheritable = false;
public void reset(){
fDefault = null;
fAttrDecl = null;
fUse = SchemaSymbols.USE_OPTIONAL;
fConstraintType = XSConstants.VC_NONE;
fAnnotations = null;
fInheritable = false;
}
/**
* 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;
}
/**
* Tells whether this attribute is declared inheritable.
*/
public boolean getInheritable() {
return fInheritable;
}
} // class XSAttributeUseImpl