|
LixM ME 1.3(1.3.0) | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectorg.lixm.optional.v10.atattch.impl.nojsr172.helper.MXParser
public class MXParser
Absolutely minimal implementation of XMLPULL V1 API
フィールドの概要 |
---|
インタフェース org.lixm.optional.v10.atattch.impl.nojsr172.helper.XmlPullParser から継承されたフィールド |
---|
CDSECT, COMMENT, DOCDECL, END_DOCUMENT, END_TAG, ENTITY_REF, FEATURE_PROCESS_DOCDECL, FEATURE_PROCESS_NAMESPACES, FEATURE_REPORT_NAMESPACE_ATTRIBUTES, FEATURE_VALIDATION, IGNORABLE_WHITESPACE, NO_NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_TAG, TEXT, TYPES |
コンストラクタの概要 | |
---|---|
MXParser()
|
メソッドの概要 | |
---|---|
void |
defineEntityReplacementText(java.lang.String entityName,
java.lang.String replacementText)
Set new value for entity replacement text as defined in XML 1.0 Section 4.5 Construction of Internal Entity Replacement Text. |
int |
getAttributeCount()
Returns the number of attributes of the current start tag, or -1 if the current event type is not START_TAG |
java.lang.String |
getAttributeName(int index)
Returns the local name of the specified attribute if namespaces are enabled or just attribute name if namespaces are disabled. |
java.lang.String |
getAttributeNamespace(int index)
Returns the namespace URI of the attribute with the given index (starts from 0). |
java.lang.String |
getAttributePrefix(int index)
Returns the prefix of the specified attribute Returns null if the element has no prefix. |
java.lang.String |
getAttributeType(int index)
Returns the type of the specified attribute If parser is non-validating it MUST return CDATA. |
java.lang.String |
getAttributeValue(int index)
Returns the given attributes value. |
java.lang.String |
getAttributeValue(java.lang.String namespace,
java.lang.String name)
Returns the attributes value identified by namespace URI and namespace localName. |
int |
getColumnNumber()
Returns the current column number, starting from 0. |
int |
getDepth()
Returns the current depth of the element. |
int |
getEventType()
Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.) |
boolean |
getFeature(java.lang.String name)
Unknown properties are |
java.lang.String |
getInputEncoding()
Returns the input encoding if known, null otherwise. |
int |
getLineNumber()
Returns the current line number, starting from 1. |
java.lang.String |
getName()
For START_TAG or END_TAG events, the (local) name of the current element is returned when namespaces are enabled. |
java.lang.String |
getNamespace()
Returns the namespace URI of the current element. |
java.lang.String |
getNamespace(java.lang.String prefix)
Returns the URI corresponding to the given prefix, depending on current state of the parser. |
int |
getNamespaceCount(int depth)
Returns the numbers of elements in the namespace stack for the given depth. |
java.lang.String |
getNamespacePrefix(int pos)
Returns the namespace prefixe for the given position in the namespace stack. |
java.lang.String |
getNamespaceUri(int pos)
Returns the namespace URI for the given position in the namespace stack If the position is out of range, an exception is thrown. |
java.lang.String |
getPositionDescription()
Return string describing current position of parsers as text 'STATE [seen %s...] |
java.lang.String |
getPrefix()
Returns the prefix of the current element. |
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property. |
java.lang.String |
getText()
Returns the text content of the current event as String. |
char[] |
getTextCharacters(int[] holderForStartAndLength)
Returns the buffer that contains the text of the current event, as well as the start offset and length relevant for the current event. |
boolean |
isAttributeDefault(int index)
Returns if the specified attribute was not in input was declared in XML. |
boolean |
isEmptyElementTag()
Returns true if the current event is START_TAG and the tag is degenerated (e.g. |
boolean |
isWhitespace()
Checks whether the current TEXT event contains only whitespace characters. |
int |
next()
Get next parsing event - element content wil be coalesced and only one TEXT event must be returned for whole element content (comments and processing instructions will be ignored and emtity references must be expanded or exception mus be thrown if entity reerence can not be exapnded). |
int |
nextTag()
Call next() and return event if it is START_TAG or END_TAG otherwise throw an exception. |
java.lang.String |
nextText()
If current event is START_TAG then if next element is TEXT then element content is returned or if next event is END_TAG then empty string is returned, otherwise exception is thrown. |
int |
nextToken()
This method works similarly to next() but will expose additional event types (COMMENT, CDSECT, DOCDECL, ENTITY_REF, PROCESSING_INSTRUCTION, or IGNORABLE_WHITESPACE) if they are available in input. |
int |
parseEndTag()
|
int |
parseStartTag()
|
void |
require(int type,
java.lang.String namespace,
java.lang.String name)
Test if the current event is of the given type and if the namespace and name do match. null will match any namespace and any name. |
void |
setFeature(java.lang.String name,
boolean state)
Method setFeature |
void |
setInput(java.io.InputStream inputStream,
java.lang.String inputEncoding)
Sets the input stream the parser is going to process. |
void |
setInput(java.io.Reader in)
Set the input source for parser to the given reader and resets the parser. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set the value of a property. |
void |
skipSubTree()
Skip sub tree that is currently porser positioned on. |
クラス java.lang.Object から継承されたメソッド |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public MXParser()
メソッドの詳細 |
---|
public void setFeature(java.lang.String name, boolean state) throws XmlPullParserException
XmlPullParser
内の setFeature
name
- a Stringstate
- a boolean
XmlPullParserException
public boolean getFeature(java.lang.String name)
XmlPullParser
内の getFeature
name
- The name of feature to be retrieved.
public void setProperty(java.lang.String name, java.lang.Object value) throws XmlPullParserException
XmlPullParser
の記述:
XmlPullParser
内の setProperty
XmlPullParserException
- If the property is not supported or can not be setpublic java.lang.Object getProperty(java.lang.String name)
XmlPullParser
の記述:NOTE: unknown properties are always returned as null.
XmlPullParser
内の getProperty
name
- The name of property to be retrieved.
public void setInput(java.io.Reader in) throws XmlPullParserException
XmlPullParser
の記述:
XmlPullParser
内の setInput
XmlPullParserException
public void setInput(java.io.InputStream inputStream, java.lang.String inputEncoding) throws XmlPullParserException
XmlPullParser
の記述:NOTE: If an input encoding string is passed, it MUST be used. Otherwise, if inputEncoding is null, the parser SHOULD try to determine input encoding following XML 1.0 specification (see below). If encoding detection is supported then following feature http://xmlpull.org/v1/doc/features.html#detect-encoding MUST be true amd otherwise it must be false
XmlPullParser
内の setInput
inputStream
- contains a raw byte input stream of possibly
unknown encoding (when inputEncoding is null).inputEncoding
- if not null it MUST be used as encoding for inputStream
XmlPullParserException
public java.lang.String getInputEncoding()
XmlPullParser
の記述:
XmlPullParser
内の getInputEncoding
public void defineEntityReplacementText(java.lang.String entityName, java.lang.String replacementText) throws XmlPullParserException
XmlPullParser
の記述:The motivation for this function is to allow very small implementations of XMLPULL that will work in J2ME environments. Though these implementations may not be able to process the document type declaration, they still can work with known DTDs by using this function.
Please notes: The given value is used literally as replacement text and it corresponds to declaring entity in DTD that has all special characters escaped: left angle bracket is replaced with <, ampersnad with & and so on.
Note: The given value is the literal replacement text and must not contain any other entity reference (if it contains any entity reference there will be no further replacement).
Note: The list of pre-defined entity names will always contain standard XML entities such as amp (&), lt (<), gt (>), quot ("), and apos ('). Those cannot be redefined by this method!
XmlPullParser
内の defineEntityReplacementText
XmlPullParserException
XmlPullParser.setInput(java.io.Reader)
,
XmlPullParser.FEATURE_PROCESS_DOCDECL
,
XmlPullParser.FEATURE_VALIDATION
public int getNamespaceCount(int depth) throws XmlPullParserException
XmlPullParser
の記述:NOTE: when parser is on END_TAG then it is allowed to call this function with getDepth()+1 argument to retrieve position of namespace prefixes and URIs that were declared on corresponding START_TAG.
NOTE: to retrieve lsit of namespaces declared in current element:
XmlPullParser pp = ... int nsStart = pp.getNamespaceCount(pp.getDepth()-1); int nsEnd = pp.getNamespaceCount(pp.getDepth()); for (int i = nsStart; i < nsEnd; i++) { String prefix = pp.getNamespacePrefix(i); String ns = pp.getNamespaceUri(i); // ... }
XmlPullParser
内の getNamespaceCount
XmlPullParserException
XmlPullParser.getNamespacePrefix(int)
,
XmlPullParser.getNamespaceUri(int)
,
XmlPullParser.getNamespace()
,
XmlPullParser.getNamespace(String)
public java.lang.String getNamespacePrefix(int pos) throws XmlPullParserException
XmlPullParser
の記述:Please note: when the parser is on an END_TAG, namespace prefixes that were declared in the corresponding START_TAG are still accessible although they are no longer in scope.
XmlPullParser
内の getNamespacePrefix
XmlPullParserException
public java.lang.String getNamespaceUri(int pos) throws XmlPullParserException
XmlPullParser
の記述:NOTE: when parser is on END_TAG then namespace prefixes that were declared in corresponding START_TAG are still accessible even though they are not in scope
XmlPullParser
内の getNamespaceUri
XmlPullParserException
public java.lang.String getNamespace(java.lang.String prefix)
XmlPullParser
の記述:If the prefix was not declared in the current scope, null is returned. The default namespace is included in the namespace table and is available via getNamespace (null).
This method is a convenience method for
for (int i = getNamespaceCount(getDepth ())-1; i >= 0; i--) { if (getNamespacePrefix(i).equals( prefix )) { return getNamespaceUri(i); } } return null;
Please note: parser implementations may provide more efifcient lookup, e.g. using a Hashtable. The 'xml' prefix is bound to "http://www.w3.org/XML/1998/namespace", as defined in the Namespaces in XML specification. Analogous, the 'xmlns' prefix is resolved to http://www.w3.org/2000/xmlns/
XmlPullParser
内の getNamespace
XmlPullParser.getNamespaceCount(int)
,
XmlPullParser.getNamespacePrefix(int)
,
XmlPullParser.getNamespaceUri(int)
public int getDepth()
XmlPullParser
の記述:<!-- outside --> 0 <root> 1 sometext 1 <foobar> 2 </foobar> 2 </root> 1 <!-- outside --> 0
XmlPullParser
内の getDepth
public java.lang.String getPositionDescription()
XmlPullParser
内の getPositionDescription
public int getLineNumber()
XmlPullParser
の記述:
XmlPullParser
内の getLineNumber
public int getColumnNumber()
XmlPullParser
の記述:
XmlPullParser
内の getColumnNumber
public boolean isWhitespace() throws XmlPullParserException
XmlPullParser
の記述:Please note: non-validating parsers are not able to distinguish whitespace and ignorable whitespace, except from whitespace outside the root element. Ignorable whitespace is reported as separate event, which is exposed via nextToken only.
XmlPullParser
内の isWhitespace
XmlPullParserException
public java.lang.String getText()
XmlPullParser
の記述:NOTE: in case of ENTITY_REF, this method returns the entity replacement text (or null if not available). This is the only case where getText() and getTextCharacters() return different values.
XmlPullParser
内の getText
XmlPullParser.getEventType()
,
XmlPullParser.next()
,
XmlPullParser.nextToken()
public char[] getTextCharacters(int[] holderForStartAndLength)
XmlPullParser
の記述:Please note: this buffer must not be modified and its content MAY change after a call to next() or nextToken(). This method will always return the same value as getText(), except for ENTITY_REF. In the case of ENTITY ref, getText() returns the replacement text and this method returns the actual input buffer containing the entity name. If getText() returns null, this method returns null as well and the values returned in the holder array MUST be -1 (both start and length).
XmlPullParser
内の getTextCharacters
holderForStartAndLength
- Must hold an 2-element int array
into which the start offset and length values will be written.
XmlPullParser.getText()
,
XmlPullParser.next()
,
XmlPullParser.nextToken()
public java.lang.String getNamespace()
XmlPullParser
の記述:
XmlPullParser
内の getNamespace
public java.lang.String getName()
XmlPullParser
の記述:Please note: To reconstruct the raw element name when namespaces are enabled and the prefix is not null, you will need to add the prefix and a colon to localName..
XmlPullParser
内の getName
public java.lang.String getPrefix()
XmlPullParser
の記述:
XmlPullParser
内の getPrefix
public boolean isEmptyElementTag() throws XmlPullParserException
XmlPullParser
の記述:NOTE: if the parser is not on START_TAG, an exception will be thrown.
XmlPullParser
内の isEmptyElementTag
XmlPullParserException
public int getAttributeCount()
XmlPullParser
の記述:
XmlPullParser
内の getAttributeCount
XmlPullParser.getAttributeNamespace(int)
,
XmlPullParser.getAttributeName(int)
,
XmlPullParser.getAttributePrefix(int)
,
XmlPullParser.getAttributeValue(int)
public java.lang.String getAttributeNamespace(int index)
XmlPullParser
の記述:NOTE: if FEATURE_REPORT_NAMESPACE_ATTRIBUTES is set then namespace attributes (xmlns:ns='...') must be reported with namespace http://www.w3.org/2000/xmlns/ (visit this URL for description!). The default namespace attribute (xmlns="...") will be reported with empty namespace.
NOTE:The xml prefix is bound as defined in Namespaces in XML specification to "http://www.w3.org/XML/1998/namespace".
XmlPullParser
内の getAttributeNamespace
public java.lang.String getAttributeName(int index)
XmlPullParser
の記述:
XmlPullParser
内の getAttributeName
public java.lang.String getAttributePrefix(int index)
XmlPullParser
の記述:
XmlPullParser
内の getAttributePrefix
public java.lang.String getAttributeType(int index)
XmlPullParser
の記述:
XmlPullParser
内の getAttributeType
public boolean isAttributeDefault(int index)
XmlPullParser
の記述:
XmlPullParser
内の isAttributeDefault
public java.lang.String getAttributeValue(int index)
XmlPullParser
の記述:NOTE: attribute value must be normalized (including entity replacement text if PROCESS_DOCDECL is false) as described in XML 1.0 section 3.3.3 Attribute-Value Normalization
XmlPullParser
内の getAttributeValue
XmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)
public java.lang.String getAttributeValue(java.lang.String namespace, java.lang.String name)
XmlPullParser
の記述:NOTE: attribute value must be normalized (including entity replacement text if PROCESS_DOCDECL is false) as described in XML 1.0 section 3.3.3 Attribute-Value Normalization
XmlPullParser
内の getAttributeValue
namespace
- Namespace of the attribute if namespaces are enabled otherwise must be nullname
- If namespaces enabled local name of attribute otherwise just attribute name
XmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)
public int getEventType() throws XmlPullParserException
XmlPullParser
の記述:
XmlPullParser
内の getEventType
XmlPullParserException
XmlPullParser.next()
,
XmlPullParser.nextToken()
public void require(int type, java.lang.String namespace, java.lang.String name) throws XmlPullParserException, java.io.IOException
XmlPullParser
の記述:Essentially it does this
if (type != getEventType() || (namespace != null && !namespace.equals( getNamespace () ) ) || (name != null && !name.equals( getName() ) ) ) throw new XmlPullParserException( "expected "+ TYPES[ type ]+getPositionDescription());
XmlPullParser
内の require
XmlPullParserException
java.io.IOException
public void skipSubTree() throws XmlPullParserException, java.io.IOException
XmlPullParserException
java.io.IOException
public java.lang.String nextText() throws XmlPullParserException, java.io.IOException
XmlPullParser
の記述:The motivation for this function is to allow to parse consistently both empty elements and elements that has non empty content, for example for input:
p.nextTag() p.requireEvent(p.START_TAG, "", "tag"); String content = p.nextText(); p.requireEvent(p.END_TAG, "", "tag");This function together with nextTag make it very easy to parse XML that has no mixed content.
Essentially it does this
if(getEventType() != START_TAG) { throw new XmlPullParserException( "parser must be on START_TAG to read next text", this, null); } int eventType = next(); if(eventType == TEXT) { String result = getText(); eventType = next(); if(eventType != END_TAG) { throw new XmlPullParserException( "event TEXT it must be immediately followed by END_TAG", this, null); } return result; } else if(eventType == END_TAG) { return ""; } else { throw new XmlPullParserException( "parser must be on START_TAG or TEXT to read text", this, null); }
XmlPullParser
内の nextText
XmlPullParserException
java.io.IOException
public int nextTag() throws XmlPullParserException, java.io.IOException
XmlPullParser
の記述:essentially it does this
int eventType = next(); if(eventType == TEXT && isWhitespace()) { // skip whitespace eventType = next(); } if (eventType != START_TAG && eventType != END_TAG) { throw new XmlPullParserException("expected start or end tag", this, null); } return eventType;
XmlPullParser
内の nextTag
XmlPullParserException
java.io.IOException
public int next() throws XmlPullParserException, java.io.IOException
XmlPullParser
の記述:NOTE: empty element (such as <tag/>) will be reported with two separate events: START_TAG, END_TAG - it must be so to preserve parsing equivalency of empty element to <tag></tag>. (see isEmptyElementTag ())
XmlPullParser
内の next
XmlPullParserException
java.io.IOException
XmlPullParser.isEmptyElementTag()
,
XmlPullParser.START_TAG
,
XmlPullParser.TEXT
,
XmlPullParser.END_TAG
,
XmlPullParser.END_DOCUMENT
public int nextToken() throws XmlPullParserException, java.io.IOException
XmlPullParser
の記述:If special feature FEATURE_XML_ROUNDTRIP (identified by URI: http://xmlpull.org/v1/doc/features.html#xml-roundtrip) is enabled it is possible to do XML document round trip ie. reproduce exectly on output the XML input using getText(): returned content is always unnormalized (exactly as in input). Otherwise returned content is end-of-line normalized as described XML 1.0 End-of-Line Handling and. Also when this feature is enabled exact content of START_TAG, END_TAG, DOCDECL and PROCESSING_INSTRUCTION is available.
Here is the list of tokens that can be returned from nextToken() and what getText() and getTextCharacters() returns:
" titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd" [<!ENTITY % active.links "INCLUDE">]"
for input document that contained:
<!DOCTYPE titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd" [<!ENTITY % active.links "INCLUDE">]>otherwise if FEATURE_XML_ROUNDTRIP is false and PROCESS_DOCDECL is true then what is returned is undefined (it may be even null)
NOTE: there is no gurantee that there will only one TEXT or IGNORABLE_WHITESPACE event from nextToken() as parser may chose to deliver element content in multiple tokens (dividing element content into chunks)
NOTE: whether returned text of token is end-of-line normalized is depending on FEATURE_XML_ROUNDTRIP.
NOTE: XMLDecl (<?xml ...?>) is not reported but its content is available through optional properties (see class description above).
XmlPullParser
内の nextToken
XmlPullParserException
java.io.IOException
XmlPullParser.next()
,
XmlPullParser.START_TAG
,
XmlPullParser.TEXT
,
XmlPullParser.END_TAG
,
XmlPullParser.END_DOCUMENT
,
XmlPullParser.COMMENT
,
XmlPullParser.DOCDECL
,
XmlPullParser.PROCESSING_INSTRUCTION
,
XmlPullParser.ENTITY_REF
,
XmlPullParser.IGNORABLE_WHITESPACE
public int parseEndTag() throws XmlPullParserException, java.io.IOException
XmlPullParserException
java.io.IOException
public int parseStartTag() throws XmlPullParserException, java.io.IOException
XmlPullParserException
java.io.IOException
|
LixM ME 1.3(1.3.0) | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |