Top Description Fields Constructors Methods
com.ctc.wstx.msv

pack-priv final Class AttributeProxy

extends Object
implements Attributes
Class Inheritance
All Implemented Interfaces
org.xml.sax.Attributes
Imports
org.codehaus.stax2.validation.ValidationContext
This is an implementation of SAX Attributes interface, that proxies requests to the ValidationContext. It is needed by some MSV components (specifically, W3C Schema Validator) for limited access to attribute values during start element validation.

Field Summary

Modifier and TypeField and Description
private final ValidationContext
mContext

Constructor Summary

AccessConstructor and Description
public
AttributeProxy(ValidationContext ctxt)

Method Summary

Modifier and TypeMethod and Description
public int
getIndex(String
The qualified (prefixed) name.
qName)

Implements org.xml.sax.Attributes.getIndex.

Look up the index of an attribute by XML qualified (prefixed) name.

public int
getIndex(String
The Namespace URI, or the empty string if the name has no Namespace URI.
uri, String
The attribute's local name.
localName)

Implements org.xml.sax.Attributes.getIndex.

Look up the index of an attribute by Namespace name.

public int
getLength()

Implements org.xml.sax.Attributes.getLength.

Return the number of attributes in the list.

public String
getLocalName(int
The attribute index (zero-based).
index)

Implements org.xml.sax.Attributes.getLocalName.

Look up an attribute's local name by index.

public String
getQName(int
The attribute index (zero-based).
index)

Implements org.xml.sax.Attributes.getQName.

Look up an attribute's XML qualified (prefixed) name by index.

public String
getType(int
The attribute index (zero-based).
index)

Implements org.xml.sax.Attributes.getType.

Look up an attribute's type by index.

public String
getType(String
The XML qualified name.
qName)

Implements org.xml.sax.Attributes.getType.

Look up an attribute's type by XML qualified (prefixed) name.

public String
getType(String
The Namespace URI, or the empty String if the name has no Namespace URI.
uri, String
The local name of the attribute.
localName)

Implements org.xml.sax.Attributes.getType.

Look up an attribute's type by Namespace name.

public String
getURI(int
The attribute index (zero-based).
index)

Implements org.xml.sax.Attributes.getURI.

Look up an attribute's Namespace URI by index.

public String
getValue(int
The attribute index (zero-based).
index)

Implements org.xml.sax.Attributes.getValue.

Look up an attribute's value by index.

public String
getValue(String
The XML qualified name.
qName)

Implements org.xml.sax.Attributes.getValue.

Look up an attribute's value by XML qualified (prefixed) name.

public String
getValue(String
The Namespace URI, or the empty String if the name has no Namespace URI.
uri, String
The local name of the attribute.
localName)

Implements org.xml.sax.Attributes.getValue.

Look up an attribute's value by Namespace name.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

mContextback to summary
private final ValidationContext mContext

Constructor Detail

AttributeProxyback to summary
public AttributeProxy(ValidationContext ctxt)

Method Detail

getIndexback to summary
public int getIndex(String qName)

Implements org.xml.sax.Attributes.getIndex.

Doc from org.xml.sax.Attributes.getIndex.

Look up the index of an attribute by XML qualified (prefixed) name.

Parameters
qName:String

The qualified (prefixed) name.

Returns:int

The index of the attribute, or -1 if it does not appear in the list.

Annotations
@Override
getIndexback to summary
public int getIndex(String uri, String localName)

Implements org.xml.sax.Attributes.getIndex.

Doc from org.xml.sax.Attributes.getIndex.

Look up the index of an attribute by Namespace name.

Parameters
uri:String

The Namespace URI, or the empty string if the name has no Namespace URI.

localName:String

The attribute's local name.

Returns:int

The index of the attribute, or -1 if it does not appear in the list.

Annotations
@Override
getLengthback to summary
public int getLength()

Implements org.xml.sax.Attributes.getLength.

Doc from org.xml.sax.Attributes.getLength.

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Returns:int

The number of attributes in the list.

Annotations
@Override
getLocalNameback to summary
public String getLocalName(int index)

Implements org.xml.sax.Attributes.getLocalName.

Doc from org.xml.sax.Attributes.getLocalName.

Look up an attribute's local name by index.

Parameters
index:int

The attribute index (zero-based).

Returns:String

The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.

Annotations
@Override
getQNameback to summary
public String getQName(int index)

Implements org.xml.sax.Attributes.getQName.

Doc from org.xml.sax.Attributes.getQName.

Look up an attribute's XML qualified (prefixed) name by index.

Parameters
index:int

The attribute index (zero-based).

Returns:String

The XML qualified name, or the empty string if none is available, or null if the index is out of range.

Annotations
@Override
getTypeback to summary
public String getType(int index)

Implements org.xml.sax.Attributes.getType.

Doc from org.xml.sax.Attributes.getType.

Look up an attribute's type by 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 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Parameters
index:int

The attribute index (zero-based).

Returns:String

The attribute's type as a string, or null if the index is out of range.

Annotations
@Override
getTypeback to summary
public String getType(String qName)

Implements org.xml.sax.Attributes.getType.

Doc from org.xml.sax.Attributes.getType.

Look up an attribute's type by XML qualified (prefixed) name.

See getType(int) for a description of the possible types.

Parameters
qName:String

The XML qualified name.

Returns:String

The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

Annotations
@Override
getTypeback to summary
public String getType(String uri, String localName)

Implements org.xml.sax.Attributes.getType.

Doc from org.xml.sax.Attributes.getType.

Look up an attribute's type by Namespace name.

See getType(int) for a description of the possible types.

Parameters
uri:String

The Namespace URI, or the empty String if the name has no Namespace URI.

localName:String

The local name of the attribute.

Returns:String

The attribute type as a string, or null if the attribute is not in the list or if Namespace processing is not being performed.

Annotations
@Override
getURIback to summary
public String getURI(int index)

Implements org.xml.sax.Attributes.getURI.

Doc from org.xml.sax.Attributes.getURI.

Look up an attribute's Namespace URI by index.

Parameters
index:int

The attribute index (zero-based).

Returns:String

The Namespace URI, or the empty string if none is available, or null if the index is out of range.

Annotations
@Override
getValueback to summary
public String getValue(int index)

Implements org.xml.sax.Attributes.getValue.

Doc from org.xml.sax.Attributes.getValue.

Look up an attribute's value by 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.

Parameters
index:int

The attribute index (zero-based).

Returns:String

The attribute's value as a string, or null if the index is out of range.

Annotations
@Override
getValueback to summary
public String getValue(String qName)

Implements org.xml.sax.Attributes.getValue.

Doc from org.xml.sax.Attributes.getValue.

Look up an attribute's value by XML qualified (prefixed) name.

See getValue(int) for a description of the possible values.

Parameters
qName:String

The XML qualified name.

Returns:String

The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

Annotations
@Override
getValueback to summary
public String getValue(String uri, String localName)

Implements org.xml.sax.Attributes.getValue.

Doc from org.xml.sax.Attributes.getValue.

Look up an attribute's value by Namespace name.

See getValue(int) for a description of the possible values.

Parameters
uri:String

The Namespace URI, or the empty String if the name has no Namespace URI.

localName:String

The local name of the attribute.

Returns:String

The attribute value as a string, or null if the attribute is not in the list.

Annotations
@Override