Interface IAttributes

Interface for a list of XML attributes.

Namespace: Sax
Assembly: Lucene.Net.Benchmark.dll
Syntax
public interface IAttributes
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This interface allows access to a list of attributes in three different ways:

  1. by attribute index;
  2. by Namespace-qualified name; or
  3. by qualified (prefixed) name.

The list will not contain attributes that were declared

IMPLIED but not specified in the start tag. It will also not

contain attributes used as Namespace declarations(xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default). Because SAX2 conforms to the original "Namespaces in XML" recommendation, it normally does not give namespace declaration attributes a namespace URI.

Some SAX2 parsers may support using an optional feature flag (http://xml.org/sax/features/xmlns-uris) to request that those attributes be given URIs, conforming to a later backwards-incompatible revision of that recommendation. (The attribute's "local name" will be the prefix, or "xmlns" when defining a default element namespace.) For portability, handler code should always resolve that conflict, rather than requiring parsers that can change the setting of that feature flag. If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if the

http://xml.org/sax/features/namespaces
feature is false, access by Namespace-qualified names may not be available.

This interface replaces the now-deprecated SAX1 { @link org.xml.sax.AttributeList AttributeList } interface, which does not contain Namespace support.In addition to Namespace support, it adds the getIndex methods (below).

The order of attributes in the list is unspecified, and will vary from implementation to implementation.

Properties

| Improve this Doc View Source

Length

Return the number of attributes in the list.

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

Declaration
int Length { get; }
Property Value
Type Description
System.Int32

The number of attributes in the list.
See Also

Methods

| Improve this Doc View Source

GetIndex(String)

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

Declaration
int GetIndex(string qName)
Parameters
Type Name Description
System.String qName

The qualified (prefixed) name.
Returns
Type Description
System.Int32

The index of the attribute, or -1 if it does not appear in the list.
| Improve this Doc View Source

GetIndex(String, String)

Look up the index of an attribute by Namespace name.

Declaration
int GetIndex(string uri, string localName)
Parameters
Type Name Description
System.String uri

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

The attribute's local name.
Returns
Type Description
System.Int32

The index of the attribute, or -1 if it does not appear in the list.
| Improve this Doc View Source

GetLocalName(Int32)

Look up an attribute's local name by index.

Declaration
string GetLocalName(int index)
Parameters
Type Name Description
System.Int32 index

The attribute index (zero-based).
Returns
Type Description
System.String

The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.
See Also
| Improve this Doc View Source

GetQName(Int32)

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

Declaration
string GetQName(int index)
Parameters
Type Name Description
System.Int32 index

The attribute index (zero-based).
Returns
Type Description
System.String

The XML qualified name, or the empty string if none is available, or null if the index is out of range.
See Also
| Improve this Doc View Source

GetType(Int32)

Look up an attribute's type by index.

Declaration
string GetType(int index)
Parameters
Type Name Description
System.Int32 index

The attribute index (zero-based).
Returns
Type Description
System.String

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

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".

See Also
| Improve this Doc View Source

GetType(String)

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

See GetType(Int32) for a description of the possible types.

Declaration
string GetType(string qName)
Parameters
Type Name Description
System.String qName

The XML qualified name.
Returns
Type Description
System.String

The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.
| Improve this Doc View Source

GetType(String, String)

Look up an attribute's type by Namespace name.

See GetType(Int32) for a description of the possible types.

Declaration
string GetType(string uri, string localName)
Parameters
Type Name Description
System.String uri

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

The local name of the attribute.
Returns
Type Description
System.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.
| Improve this Doc View Source

GetURI(Int32)

Look up an attribute's Namespace URI by index.

Declaration
string GetURI(int index)
Parameters
Type Name Description
System.Int32 index

The attribute index (zero-based).
Returns
Type Description
System.String

The Namespace URI, or the empty string if none is available, or null if the index is out of range.
See Also
| Improve this Doc View Source

GetValue(Int32)

Look up an attribute's value by index.

Declaration
string GetValue(int index)
Parameters
Type Name Description
System.Int32 index

The attribute index (zero-based).
Returns
Type Description
System.String

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

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.

See Also
| Improve this Doc View Source

GetValue(String)

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

See GetValue(Int32) for a description of the possible values.

Declaration
string GetValue(string qName)
Parameters
Type Name Description
System.String qName
Returns
Type Description
System.String
| Improve this Doc View Source

GetValue(String, String)

Look up an attribute's value by Namespace name.

See GetValue(Int32) for a description of the possible values.

Declaration
string GetValue(string uri, string localName)
Parameters
Type Name Description
System.String uri

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

The local name of the attribute.
Returns
Type Description
System.String

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

See Also