Java Doc for Attributes.java in  » 6.0-JDK-Core » xml » org » xml » sax » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » xml » org.xml.sax 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.xml.sax.Attributes

All known Subclasses:   org.xml.sax.helpers.AttributesImpl,
Attributes
public interface Attributes (Code)
Interface for a list of XML attributes.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://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 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.


since:
   SAX 2.0
author:
   David Megginson
version:
   2.0.1 (sax2r2)
See Also:   org.xml.sax.helpers.AttributesImpl
See Also:   org.xml.sax.ext.DeclHandler.attributeDecl




Method Summary
public  intgetIndex(String uri, String localName)
     Look up the index of an attribute by Namespace name.
Parameters:
  uri - The Namespace URI, or the empty string ifthe name has no Namespace URI.
Parameters:
  localName - The attribute's local name.
public  intgetIndex(String qName)
     Look up the index of an attribute by XML qualified (prefixed) name.
Parameters:
  qName - The qualified (prefixed) name.
abstract public  intgetLength()
     Return the number of attributes in the list.
abstract public  StringgetLocalName(int index)
     Look up an attribute's local name by index.
Parameters:
  index - The attribute index (zero-based).
abstract public  StringgetQName(int index)
     Look up an attribute's XML qualified (prefixed) name by index.
Parameters:
  index - The attribute index (zero-based).
abstract public  StringgetType(int index)
     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 - The attribute index (zero-based).
abstract public  StringgetType(String uri, String localName)
     Look up an attribute's type by Namespace name.

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


Parameters:
  uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
  localName - The local name of the attribute.
abstract public  StringgetType(String qName)
     Look up an attribute's type by XML qualified (prefixed) name.

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


Parameters:
  qName - The XML qualified name.
abstract public  StringgetURI(int index)
     Look up an attribute's Namespace URI by index.
Parameters:
  index - The attribute index (zero-based).
abstract public  StringgetValue(int index)
     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 - The attribute index (zero-based).
abstract public  StringgetValue(String uri, String localName)
     Look up an attribute's value by Namespace name.

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


Parameters:
  uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
  localName - The local name of the attribute.
abstract public  StringgetValue(String qName)
     Look up an attribute's value by XML qualified (prefixed) name.

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


Parameters:
  qName - The XML qualified name.



Method Detail
getIndex
public int getIndex(String uri, String localName)(Code)
Look up the index of an attribute by Namespace name.
Parameters:
  uri - The Namespace URI, or the empty string ifthe name has no Namespace URI.
Parameters:
  localName - The attribute's local name. The index of the attribute, or -1 if it does notappear in the list.



getIndex
public int getIndex(String qName)(Code)
Look up the index of an attribute by XML qualified (prefixed) name.
Parameters:
  qName - The qualified (prefixed) name. The index of the attribute, or -1 if it does notappear in the list.



getLength
abstract public int getLength()(Code)
Return the number of attributes in the list.

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

The number of attributes in the list.
See Also:   Attributes.getURI(int)
See Also:   Attributes.getLocalName(int)
See Also:   Attributes.getQName(int)
See Also:   Attributes.getType(int)
See Also:   Attributes.getValue(int)



getLocalName
abstract public String getLocalName(int index)(Code)
Look up an attribute's local name by index.
Parameters:
  index - The attribute index (zero-based). The local name, or the empty string if Namespaceprocessing is not being performed, or nullif the index is out of range.
See Also:   Attributes.getLength



getQName
abstract public String getQName(int index)(Code)
Look up an attribute's XML qualified (prefixed) name by index.
Parameters:
  index - The attribute index (zero-based). The XML qualified name, or the empty stringif none is available, or null if the indexis out of range.
See Also:   Attributes.getLength



getType
abstract public String getType(int index)(Code)
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 - The attribute index (zero-based). The attribute's type as a string, or null if theindex is out of range.
See Also:   Attributes.getLength



getType
abstract public String getType(String uri, String localName)(Code)
Look up an attribute's type by Namespace name.

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


Parameters:
  uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
  localName - The local name of the attribute. The attribute type as a string, or null if theattribute is not in the list or if Namespaceprocessing is not being performed.



getType
abstract public String getType(String qName)(Code)
Look up an attribute's type by XML qualified (prefixed) name.

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


Parameters:
  qName - The XML qualified name. The attribute type as a string, or null if theattribute is not in the list or if qualified namesare not available.



getURI
abstract public String getURI(int index)(Code)
Look up an attribute's Namespace URI by index.
Parameters:
  index - The attribute index (zero-based). The Namespace URI, or the empty string if noneis available, or null if the index is out ofrange.
See Also:   Attributes.getLength



getValue
abstract public String getValue(int index)(Code)
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 - The attribute index (zero-based). The attribute's value as a string, or null if theindex is out of range.
See Also:   Attributes.getLength



getValue
abstract public String getValue(String uri, String localName)(Code)
Look up an attribute's value by Namespace name.

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


Parameters:
  uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
  localName - The local name of the attribute. The attribute value as a string, or null if theattribute is not in the list.



getValue
abstract public String getValue(String qName)(Code)
Look up an attribute's value by XML qualified (prefixed) name.

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


Parameters:
  qName - The XML qualified name. The attribute value as a string, or null if theattribute is not in the list or if qualified namesare not available.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.