|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.util.XMLAttributesImpl
public class XMLAttributesImpl
The XMLAttributesImpl class is an implementation of the XMLAttributes interface which defines a collection of attributes for an element. In the parser, the document source would scan the entire start element and collect the attributes. The attributes are communicated to the document handler in the startElement method.
The attributes are read-write so that subsequent stages in the document pipeline can modify the values or change the attributes that are propogated to the next stage.
XMLDocumentHandler.startElement(org.apache.xerces.xni.QName, org.apache.xerces.xni.XMLAttributes, org.apache.xerces.xni.Augmentations)
Constructor Summary | |
---|---|
XMLAttributesImpl()
Default constructor. |
|
XMLAttributesImpl(int tableSize)
|
Method Summary | |
---|---|
int |
addAttribute(QName name,
java.lang.String type,
java.lang.String value)
Adds an attribute. |
void |
addAttributeNS(QName name,
java.lang.String type,
java.lang.String value)
Adds an attribute. |
QName |
checkDuplicatesNS()
Checks for duplicate expanded names (local part and namespace name pairs) in the attribute specification. |
Augmentations |
getAugmentations(int attributeIndex)
Look up an augmentations by attributes index. |
Augmentations |
getAugmentations(java.lang.String qName)
Look up an augmentation by XML 1.0 qualified name. |
Augmentations |
getAugmentations(java.lang.String uri,
java.lang.String localName)
Look up an augmentations by Namespace name. |
int |
getIndex(java.lang.String qName)
Look up the index of an attribute by XML 1.0 qualified name. |
int |
getIndex(java.lang.String uri,
java.lang.String localPart)
Look up the index of an attribute by Namespace name. |
int |
getIndexFast(java.lang.String qName)
Look up the index of an attribute by XML 1.0 qualified name. |
int |
getIndexFast(java.lang.String uri,
java.lang.String localPart)
Look up the index of an attribute by Namespace name. |
int |
getLength()
Return the number of attributes in the list. |
java.lang.String |
getLocalName(int index)
Look up an attribute's local name by index. |
java.lang.String |
getName(int index)
Return the name of an attribute in this list (by position). |
void |
getName(int attrIndex,
QName attrName)
Sets the fields in the given QName structure with the values of the attribute name at the specified index. |
java.lang.String |
getNonNormalizedValue(int attrIndex)
Returns the non-normalized value of the attribute at the specified index. |
java.lang.String |
getPrefix(int index)
Returns the prefix of the attribute at the specified index. |
java.lang.String |
getQName(int index)
Look up an attribute's XML 1.0 qualified name by index. |
boolean |
getSchemaId(int index)
|
boolean |
getSchemaId(java.lang.String qname)
|
boolean |
getSchemaId(java.lang.String uri,
java.lang.String localName)
|
java.lang.String |
getType(int index)
Look up an attribute's type by index. |
java.lang.String |
getType(java.lang.String qname)
Look up an attribute's type by XML 1.0 qualified name. |
java.lang.String |
getType(java.lang.String uri,
java.lang.String localName)
Look up an attribute's type by Namespace name. |
java.lang.String |
getURI(int index)
Look up an attribute's Namespace URI by index. |
java.lang.String |
getValue(int index)
Look up an attribute's value by index. |
java.lang.String |
getValue(java.lang.String qname)
Look up an attribute's value by XML 1.0 qualified name. |
java.lang.String |
getValue(java.lang.String uri,
java.lang.String localName)
Look up an attribute's value by Namespace name. |
boolean |
isSpecified(int attrIndex)
Returns true if the attribute is specified in the instance document. |
void |
removeAllAttributes()
Removes all of the attributes. |
void |
removeAttributeAt(int attrIndex)
Removes the attribute at the specified index. |
void |
setAugmentations(int attrIndex,
Augmentations augs)
Sets the augmentations of the attribute at the specified index. |
void |
setName(int attrIndex,
QName attrName)
Sets the name of the attribute at the specified index. |
void |
setNamespaces(boolean namespaces)
Sets whether namespace processing is being performed. |
void |
setNonNormalizedValue(int attrIndex,
java.lang.String attrValue)
Sets the non-normalized value of the attribute at the specified index. |
void |
setSchemaId(int attrIndex,
boolean schemaId)
|
void |
setSpecified(int attrIndex,
boolean specified)
Sets whether an attribute is specified in the instance document or not. |
void |
setType(int attrIndex,
java.lang.String attrType)
Sets the type of the attribute at the specified index. |
void |
setURI(int attrIndex,
java.lang.String uri)
Sets the uri of the attribute at the specified index. |
void |
setValue(int attrIndex,
java.lang.String attrValue)
Sets the value of the attribute at the specified index. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLAttributesImpl()
public XMLAttributesImpl(int tableSize)
tableSize
- initial size of table viewMethod Detail |
---|
public void setNamespaces(boolean namespaces)
namespaces
- True if namespace processing is turned on.getLocalName(int)
public int addAttribute(QName name, java.lang.String type, java.lang.String value)
setNonNormalizedValue
method. Also,
the added attribute will be marked as specified in the XML instance
document unless set otherwise using the setSpecified
method.
Note: If an attribute of the same name already exists, the old values for the attribute are replaced by the new values.
addAttribute
in interface XMLAttributes
name
- The attribute name.type
- The attribute type. The type name is determined by
the type specified for this attribute in the DTD.
For example: "CDATA", "ID", "NMTOKEN", etc. However,
attributes of type enumeration will have the type
value specified as the pipe ('|') separated list of
the enumeration values prefixed by an open
parenthesis and suffixed by a close parenthesis.
For example: "(true|false)".value
- The attribute value.
setNonNormalizedValue(int, java.lang.String)
,
setSpecified(int, boolean)
public void removeAllAttributes()
removeAllAttributes
in interface XMLAttributes
public void removeAttributeAt(int attrIndex)
Note: This operation changes the indexes of all attributes following the attribute at the specified index.
removeAttributeAt
in interface XMLAttributes
attrIndex
- The attribute index.public void setName(int attrIndex, QName attrName)
setName
in interface XMLAttributes
attrIndex
- The attribute index.attrName
- The new attribute name.public void getName(int attrIndex, QName attrName)
getName
in interface XMLAttributes
attrIndex
- The attribute index.attrName
- The attribute name structure to fill in.public void setType(int attrIndex, java.lang.String attrType)
setType
in interface XMLAttributes
attrIndex
- The attribute index.attrType
- The attribute type. The type name is determined by
the type specified for this attribute in the DTD.
For example: "CDATA", "ID", "NMTOKEN", etc. However,
attributes of type enumeration will have the type
value specified as the pipe ('|') separated list of
the enumeration values prefixed by an open
parenthesis and suffixed by a close parenthesis.
For example: "(true|false)".public void setValue(int attrIndex, java.lang.String attrValue)
setValue
in interface XMLAttributes
attrIndex
- The attribute index.attrValue
- The new attribute value.setNonNormalizedValue(int, java.lang.String)
public void setNonNormalizedValue(int attrIndex, java.lang.String attrValue)
setNonNormalizedValue
in interface XMLAttributes
attrIndex
- The attribute index.attrValue
- The new non-normalized attribute value.public java.lang.String getNonNormalizedValue(int attrIndex)
getValue(int)
method.
getNonNormalizedValue
in interface XMLAttributes
attrIndex
- The attribute index.public void setSpecified(int attrIndex, boolean specified)
setSpecified
in interface XMLAttributes
attrIndex
- The attribute index.specified
- True if the attribute is specified in the instance
document.public boolean isSpecified(int attrIndex)
isSpecified
in interface XMLAttributes
attrIndex
- The attribute index.public int getLength()
Once you know the number of attributes, you can iterate through the list.
getLength
in interface XMLAttributes
XMLAttributes.getURI(int)
,
XMLAttributes.getLocalName(int)
,
XMLAttributes.getQName(int)
,
XMLAttributes.getType(int)
,
XMLAttributes.getValue(int)
public java.lang.String getType(int index)
The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case).
If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommentation (clause 3.3.3, "Attribute-Value Normalization").
For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".
getType
in interface XMLAttributes
index
- The attribute index (zero-based).
getLength()
public java.lang.String getType(java.lang.String qname)
See getType(int)
for a description
of the possible types.
getType
in interface XMLAttributes
qname
- The XML 1.0 qualified name.
public java.lang.String getValue(int index)
If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.
getValue
in interface XMLAttributes
index
- The attribute index (zero-based).
getLength()
public java.lang.String getValue(java.lang.String qname)
See getValue(int)
for a description
of the possible values.
getValue
in interface XMLAttributes
qname
- The XML 1.0 qualified name.
public java.lang.String getName(int index)
The names must be unique: the SAX parser shall not include the same attribute twice. Attributes without values (those declared #IMPLIED without a value specified in the start tag) will be omitted from the list.
If the attribute name has a namespace prefix, the prefix will still be attached.
index
- The index of the attribute in the list (starting at 0).
getLength()
public int getIndex(java.lang.String qName)
getIndex
in interface XMLAttributes
qName
- The qualified (prefixed) name.
public int getIndex(java.lang.String uri, java.lang.String localPart)
getIndex
in interface XMLAttributes
uri
- The Namespace URI, or null if
the name has no Namespace URI.localPart
- The attribute's local name.
public java.lang.String getLocalName(int index)
getLocalName
in interface XMLAttributes
index
- The attribute index (zero-based).
getLength()
public java.lang.String getQName(int index)
getQName
in interface XMLAttributes
index
- The attribute index (zero-based).
getLength()
public java.lang.String getType(java.lang.String uri, java.lang.String localName)
See getType(int)
for a description
of the possible types.
getType
in interface XMLAttributes
uri
- The Namespace URI, or null if the
name has no Namespace URI.localName
- The local name of the attribute.
public java.lang.String getPrefix(int index)
getPrefix
in interface XMLAttributes
index
- The index of the attribute.public java.lang.String getURI(int index)
getURI
in interface XMLAttributes
index
- The attribute index (zero-based).
getLength()
public java.lang.String getValue(java.lang.String uri, java.lang.String localName)
See getValue(int)
for a description
of the possible values.
getValue
in interface XMLAttributes
uri
- The Namespace URI, or null if thelocalName
- The local name of the attribute.
public Augmentations getAugmentations(java.lang.String uri, java.lang.String localName)
getAugmentations
in interface XMLAttributes
uri
- The Namespace URI, or null if thelocalName
- The local name of the attribute.
public Augmentations getAugmentations(java.lang.String qName)
getAugmentations
in interface XMLAttributes
qName
- The XML 1.0 qualified name.
public Augmentations getAugmentations(int attributeIndex)
getAugmentations
in interface XMLAttributes
attributeIndex
- The attribute index.
public void setAugmentations(int attrIndex, Augmentations augs)
setAugmentations
in interface XMLAttributes
attrIndex
- The attribute index.augs
- The augmentations.public void setURI(int attrIndex, java.lang.String uri)
attrIndex
- The attribute index.uri
- Namespace uripublic void setSchemaId(int attrIndex, boolean schemaId)
public boolean getSchemaId(int index)
public boolean getSchemaId(java.lang.String qname)
public boolean getSchemaId(java.lang.String uri, java.lang.String localName)
public int getIndexFast(java.lang.String qName)
Note: This method uses reference comparison, and thus should only be used internally. We cannot use this method in any code exposed to users as they may not pass in unique strings.
qName
- The qualified (prefixed) name.
public void addAttributeNS(QName name, java.lang.String type, java.lang.String value)
setNonNormalizedValue
method. Also,
the added attribute will be marked as specified in the XML instance
document unless set otherwise using the setSpecified
method.
This method differs from addAttribute
in that it
does not check if an attribute of the same name already exists
in the list before adding it. In order to improve performance
of namespace processing, this method allows uniqueness checks
to be deferred until all the namespace information is available
after the entire attribute specification has been read.
Caution: If this method is called it should
not be mixed with calls to addAttribute
unless
it has been determined that all the attribute names are unique.
name
- the attribute nametype
- the attribute typevalue
- the attribute valuesetNonNormalizedValue(int, java.lang.String)
,
setSpecified(int, boolean)
,
checkDuplicatesNS()
public QName checkDuplicatesNS()
This should be called once all the in-scope namespaces for the element enclosing these attributes is known, and after all the attributes have gone through namespace binding.
public int getIndexFast(java.lang.String uri, java.lang.String localPart)
Note: This method uses reference comparison, and thus should only be used internally. We cannot use this method in any code exposed to users as they may not pass in unique strings.
uri
- The Namespace URI, or null if
the name has no Namespace URI.localPart
- The attribute's local name.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |