Implements the entity scanner methods.
getBaseSystemId
public String getBaseSystemId()
Returns the base system identifier of the currently scanned
entity, or null if none is available.
- getBaseSystemId in interface org.apache.xerces.xni.XMLLocator
getColumnNumber
public int getColumnNumber()
Return the column number where the current document event ends.
Warning: The return value from the method
is intended only as an approximation for the sake of error
reporting; it is not intended to provide sufficient information
to edit the character content of the original XML document.
The return value is an approximation of the column number
in the document entity or external parsed entity where the
markup triggering the event appears.
If possible, the SAX driver should provide the line position
of the first character after the text associated with the document
event.
If possible, the SAX driver should provide the line position
of the first character after the text associated with the document
event. The first column in each line is column 1.
- getColumnNumber in interface org.apache.xerces.xni.XMLLocator
- The column number, or -1 if none is available.
getEncoding
public String getEncoding()
Returns the encoding of the current entity.
Note that, for a given entity, this value can only be
considered final once the encoding declaration has been read (or once it
has been determined that there is no such declaration) since, no encoding
having been specified on the XMLInputSource, the parser
will make an initial "guess" which could be in error.
- getEncoding in interface org.apache.xerces.xni.XMLLocator
getExpandedSystemId
public String getExpandedSystemId()
Return the expanded system identifier for the current document event.
The return value is the expanded system identifier of the document
entity or of the external parsed entity in which the markup
triggering the event appears.
If the system identifier is a URL, the parser must resolve it
fully before passing it to the application.
- getExpandedSystemId in interface org.apache.xerces.xni.XMLLocator
- A string containing the expanded system identifier, or null
if none is available.
getLineNumber
public int getLineNumber()
Return the line number where the current document event ends.
Warning: The return value from the method
is intended only as an approximation for the sake of error
reporting; it is not intended to provide sufficient information
to edit the character content of the original XML document.
The return value is an approximation of the line number
in the document entity or external parsed entity where the
markup triggering the event appears.
If possible, the SAX driver should provide the line position
of the first character after the text associated with the document
event. The first line in the document is line 1.
- getLineNumber in interface org.apache.xerces.xni.XMLLocator
- The line number, or -1 if none is available.
getLiteralSystemId
public String getLiteralSystemId()
Return the literal system identifier for the current document event.
The return value is the literal system identifier of the document
entity or of the external parsed entity in which the markup
triggering the event appears.
- getLiteralSystemId in interface org.apache.xerces.xni.XMLLocator
- A string containing the literal system identifier, or null
if none is available.
getPublicId
public String getPublicId()
Return the public identifier for the current document event.
The return value is the public identifier of the document
entity or of the external parsed entity in which the markup
triggering the event appears.
- getPublicId in interface org.apache.xerces.xni.XMLLocator
- A string containing the public identifier, or
null if none is available.
isExternal
public boolean isExternal()
Returns true if the current entity being scanned is external.
peekChar
public int peekChar()
throws IOException
Returns the next character on the input.
Note: The character is
not consumed.
scanChar
public int scanChar()
throws IOException
Returns the next character on the input.
Note: The character is consumed.
scanContent
public int scanContent(org.apache.xerces.xni.XMLString content)
throws IOException
Scans a range of parsed character data, setting the fields of the
XMLString structure, appropriately.
Note: The characters are consumed.
Note: This method does not guarantee to return
the longest run of parsed character data. This method may return
before markup due to reaching the end of the input buffer or any
other reason.
Note: The fields contained in the XMLString
structure are not guaranteed to remain valid upon subsequent calls
to the entity scanner. Therefore, the caller is responsible for
immediately using the returned character data or making a copy of
the character data.
content
- The content structure to fill.
- Returns the next character on the input, if known. This
value may be -1 but this does note designate
end of file.
scanData
public boolean scanData(String delimiter,
XMLStringBuffer buffer)
throws IOException
Scans a range of character data up to the specified delimiter,
setting the fields of the XMLString structure, appropriately.
Note: The characters are consumed.
Note: This assumes that the internal buffer is
at least the same size, or bigger, than the length of the delimiter
and that the delimiter contains at least one character.
Note: This method does not guarantee to return
the longest run of character data. This method may return before
the delimiter due to reaching the end of the input buffer or any
other reason.
Note: The fields contained in the XMLString
structure are not guaranteed to remain valid upon subsequent calls
to the entity scanner. Therefore, the caller is responsible for
immediately using the returned character data or making a copy of
the character data.
delimiter
- The string that signifies the end of the character
data to be scanned.
- Returns true if there is more data to scan, false otherwise.
scanLiteral
public int scanLiteral(int quote,
org.apache.xerces.xni.XMLString content)
throws IOException
Scans a range of attribute value data, setting the fields of the
XMLString structure, appropriately.
Note: The characters are consumed.
Note: This method does not guarantee to return
the longest run of attribute value data. This method may return
before the quote character due to reaching the end of the input
buffer or any other reason.
Note: The fields contained in the XMLString
structure are not guaranteed to remain valid upon subsequent calls
to the entity scanner. Therefore, the caller is responsible for
immediately using the returned character data or making a copy of
the character data.
quote
- The quote character that signifies the end of the
attribute value data.content
- The content structure to fill.
- Returns the next character on the input, if known. This
value may be -1 but this does note designate
end of file.
scanNCName
public String scanNCName()
throws IOException
Returns a string matching the NCName production appearing immediately
on the input as a symbol, or null if no NCName string is present.
Note: The NCName characters are consumed.
Note: The string returned must be a symbol. The
SymbolTable can be used for this purpose.
SymbolTable
, XMLChar.isNCName(int)
, XMLChar.isNCNameStart(int)
scanName
public String scanName()
throws IOException
Returns a string matching the Name production appearing immediately
on the input as a symbol, or null if no Name string is present.
Note: The Name characters are consumed.
Note: The string returned must be a symbol. The
SymbolTable can be used for this purpose.
SymbolTable
, XMLChar.isName(int)
, XMLChar.isNameStart(int)
scanNmtoken
public String scanNmtoken()
throws IOException
Returns a string matching the NMTOKEN production appearing immediately
on the input as a symbol, or null if NMTOKEN Name string is present.
Note: The NMTOKEN characters are consumed.
Note: The string returned must be a symbol. The
SymbolTable can be used for this purpose.
SymbolTable
, XMLChar.isName(int)
scanQName
public boolean scanQName(org.apache.xerces.xni.QName qname)
throws IOException
Scans a qualified name from the input, setting the fields of the
QName structure appropriately.
Note: The qualified name characters are consumed.
Note: The strings used to set the values of the
QName structure must be symbols. The SymbolTable can be used for
this purpose.
qname
- The qualified name structure to fill.
- Returns true if a qualified name appeared immediately on
the input and was scanned, false otherwise.
SymbolTable
, XMLChar.isName(int)
, XMLChar.isNameStart(int)
setBaseSystemId
public void setBaseSystemId(String systemId)
org.apache.xerces.xni.XMLResourceIdentifier.setBaseSystemId(String)
setBufferSize
public void setBufferSize(int size)
setColumnNumber
public void setColumnNumber(int col)
org.apache.xerces.xni.XMLLocator.setColumnNumber(int)
setEncoding
public void setEncoding(String encoding)
throws IOException
Sets the encoding of the scanner. This method is used by the
scanners if the XMLDecl or TextDecl line contains an encoding
pseudo-attribute.
Note: The underlying character reader on the
current entity will be changed to accomodate the new encoding.
However, the new encoding is ignored if the current reader was
not constructed from an input stream (e.g. an external entity
that is resolved directly to the appropriate java.io.Reader
object).
encoding
- The IANA encoding name of the new encoding.
EncodingMap
setExpandedSystemId
public void setExpandedSystemId(String systemId)
org.apache.xerces.xni.XMLResourceIdentifier.setExpandedSystemId(String)
setLineNumber
public void setLineNumber(int line)
org.apache.xerces.xni.XMLLocator.setLineNumber(int)
setLiteralSystemId
public void setLiteralSystemId(String systemId)
org.apache.xerces.xni.XMLResourceIdentifier.setLiteralSystemId(String)
setPublicId
public void setPublicId(String publicId)
org.apache.xerces.xni.XMLResourceIdentifier.setPublicId(String)
skipChar
public boolean skipChar(int c)
throws IOException
Skips a character appearing immediately on the input.
Note: The character is consumed only if it matches
the specified character.
c
- The character to skip.
- Returns true if the character was skipped.
skipDeclSpaces
public boolean skipDeclSpaces()
throws IOException
Skips space characters appearing immediately on the input that would
match non-terminal S (0x09, 0x0A, 0x0D, 0x20) before end of line
normalization is performed. This is useful when scanning structures
such as the XMLDecl and TextDecl that can only contain US-ASCII
characters.
Note: The characters are consumed only if they would
match non-terminal S before end of line normalization is performed.
- Returns true if at least one space character was skipped.
XMLChar.isSpace(int)
skipSpaces
public boolean skipSpaces()
throws IOException
Skips space characters appearing immediately on the input.
Note: The characters are consumed only if they are
space characters.
- Returns true if at least one space character was skipped.
XMLChar.isSpace(int)
skipString
public boolean skipString(String s)
throws IOException
Skips the specified string appearing immediately on the input.
Note: The characters are consumed only if they are
space characters.
s
- The string to skip.
- Returns true if the string was skipped.