org.vesalainen.parsers.xml

Class XMLBaseGrammar

java.lang.Object

org.vesalainen.parsers.xml.XMLBaseGrammar

Direct Known Subclasses:

DTDParserCompilerBase, XMLDTDBaseGrammar

public abstract class XMLBaseGrammar
extends Object

Author:

tkv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLBaseGrammar.Context

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFERSIZE
protected static String	Char [2] Char ::= [#x1-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
protected boolean	external
protected Map<String,Object>	generalReferences
protected InputSource	input
protected org.vesalainen.parser.util.InputReader	inputReader
protected XMLLocator	locator
protected static String	NameChar [4a] NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]
protected static String	NameStartChar [4] NameStartChar ::= ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
protected static String	NCNameChar [4a] NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]
protected static String	NCNameStartChar [4] NCNameStartChar ::= [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
protected Map<String,Object>	parameterReferences
protected static String	PubidChar [13] PubidChar ::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]
protected static String	PubidCharMinusApostrophe
protected static String	RestrictedChar [2a] RestrictedChar ::= [#x1-#x8] | [#xB-#xC] | [#xE-#x1F] | [#x7F-#x84] | [#x86-#x9F]
protected static String	S [3] S ::= (#x20 | #x9 | #xD | #xA)+

Constructor Summary

Constructors

Constructor and Description
XMLBaseGrammar()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	aposAttValue()
protected String	aposAttValue(String str, String value)
protected String	aposAttValueStart(org.vesalainen.parser.util.InputReader reader)
protected String	aposAttValueSub(String str)
protected String	aposEntityValue()
protected String	aposEntityValue(String str, String value)
protected String	aposEntityValueStart(org.vesalainen.parser.util.InputReader reader)
protected String	aposEntityValueSub(String str)
protected String	attValue(String str)
protected abstract void	byteOrderMark()
protected void	cdSect(org.vesalainen.parser.util.InputReader r) [20] CData ::= (Char* - (Char* ']]>' Char*))
protected void	charData(org.vesalainen.parser.util.InputReader reader) [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)
protected String	charRef(int value) [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
protected int	charRefDecimal(String s)
protected int	charRefHex(String s)
protected void	comment(org.vesalainen.parser.util.InputReader reader) [15] Comment ::= ''
protected abstract int	digit(int value)
protected abstract void	document() [1] document ::= ( prolog element Misc* ) - ( Char* RestrictedChar Char* )
protected String	emptyQuote()
protected abstract String	encName(String name) [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
protected void	encodingDecl(String charset) [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'" )
protected abstract void	entityDecl() [70] EntityDecl ::= GEDecl | PEDecl
protected void	entityDef(String entityValue) [73] EntityDef ::= EntityValue | (ExternalID NDataDecl?)
protected void	entityDef(String[] externalID)
protected String	entityRef(String name) [68] EntityRef ::= '&' Name ';'
protected String	entityValue(String str)
protected char[]	eol()
protected abstract void	eq() [25] Eq ::= S? '=' S?
protected QName	eTagName(String s)
protected String[]	externalID(String systemLiteral)
protected String[]	externalID(String pubidLiteral, String systemLiteral)
protected void	geDecl(String name) [71] GEDecl ::= ''
String	getEncoding()
String	getPublicId()
String	getSystemId()
String	getXmlVersion()
protected int	hex(String value)
protected abstract void	misc() [27] Misc ::= Comment | PI | S
protected abstract String	name(String name) [5] Name ::= NameStartChar (NameChar)*
protected List<String>	names(List<String> names, String name)
protected List<String>	names(String name) [6] Names ::= Name (#x20 Name)*
protected void	nDataDecl(String name) [76] NDataDecl ::= S 'NDATA' S Name
protected abstract String	nmtoken(String nmtoken) [7] Nmtoken ::= (NameChar)+
protected List<String>	nmtokens(List<String> nmtokens, String nmtoken)
protected List<String>	nmtokens(String nmtoken) [8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*
protected abstract String	notApos(String value)
protected abstract String	notAposValue(String value)
protected void	notationDecl(String name, String publicID)
protected void	notationDecl(String name, String[] externalID) [82] NotationDecl ::= ''
protected abstract String	notQuot(String value)
protected abstract String	notQuotValue(String value)
protected String	nsAttName(String s) [1] NSAttName ::= PrefixedAttName | DefaultAttName
protected String[]	optExternalID() (S ExternalID)?
protected String[]	optExternalID(String[] externalID)
protected abstract String	parseAposAttValue(org.vesalainen.parser.util.InputReader reader)
protected abstract String	parseAposEntityValue(org.vesalainen.parser.util.InputReader reader)
protected abstract void	parseDocument(org.vesalainen.parser.util.InputReader reader)
protected abstract void	parseExtSubset(org.vesalainen.parser.util.InputReader reader)
protected abstract String	parseQuotAttValue(org.vesalainen.parser.util.InputReader reader)
protected abstract String	parseQuotEntityValue(org.vesalainen.parser.util.InputReader reader)
protected void	peDecl(String name, Object value) [72] PEDecl ::= ''
protected Object	peDef(String entityValue) [74] PEDef ::= EntityValue | ExternalID
protected Object	peDef(String[] externalID)
protected String	peReference(String name, org.vesalainen.parser.util.InputReader reader) [69] PEReference ::= '%' Name ';'
protected void	pi() [16] PI ::= '' Char*)))? '?>'
protected abstract String	pubidLiteral(String literal) [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"
protected String	pubidLiteralMinusApostrophe(String value)
protected String	pubidLiteralWithApostrophe(String value)
protected abstract String	publicID(String id) [83] PublicID ::= 'PUBLIC' S PubidLiteral
protected QName	qName(String s)
protected String	quotAttValue()
protected String	quotAttValue(String str, String value)
protected String	quotAttValueStart(org.vesalainen.parser.util.InputReader reader) [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'"
protected String	quotAttValueSub(String str)
protected String	quotEntityValue()
protected String	quotEntityValue(String str, String value)
protected String	quotEntityValueStart(org.vesalainen.parser.util.InputReader reader) [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"
protected String	quotEntityValueSub(String str)
protected abstract String	reference(String value) [67] Reference ::= EntityRef | CharRef
protected abstract void	s()
protected void	sdDecl(boolean opt) [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"'))
void	setExternal(boolean external)
void	setPublicId(String publicId)
void	setSystemId(String systemId)
void	setXmlVersion(String xmlVersion)
protected abstract void	singleApostrophe()
protected abstract void	singleQuot()
protected QName	sTagName(String s) [4] NCName ::= NCNameStartChar NCNameChar*
protected String	systemLiteral(String literal) [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")
protected void	utf16BE()
protected void	utf16BEPrefix()
protected void	utf16LE()
protected void	utf16LEPrefix()
protected void	utf32BE()
protected void	utf32BEPrefix()
protected void	utf32LE()
protected void	utf32LEPrefix()
protected void	utf8()
protected abstract void	utf8Prefix()
protected String	version(String version)
protected void	versionInfo(String version) [24] VersionInfo ::= S 'version' Eq ("'" VersionNum "'" | '"' VersionNum '"')
protected abstract String	versionNum(String version) [26] VersionNum ::= '1.1'
protected abstract void	xmlDecl() [23] XMLDecl ::= ''
protected abstract void	xmlPrefix()
protected boolean	yesNo(String opt)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUFFERSIZE

public static final int BUFFERSIZE

See Also:

Constant Field Values

Char

protected static final String Char

[2] Char ::= [#x1-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]

See Also:

Constant Field Values

RestrictedChar

protected static final String RestrictedChar

[2a] RestrictedChar ::= [#x1-#x8] | [#xB-#xC] | [#xE-#x1F] | [#x7F-#x84] | [#x86-#x9F]

See Also:

Constant Field Values

S

protected static final String S

[3] S ::= (#x20 | #x9 | #xD | #xA)+

See Also:

Constant Field Values

NameStartChar

protected static final String NameStartChar

[4] NameStartChar ::= ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]

See Also:

Constant Field Values

NameChar

protected static final String NameChar

[4a] NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]

See Also:

Constant Field Values

PubidChar

protected static final String PubidChar

[13] PubidChar ::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]

See Also:

Constant Field Values

PubidCharMinusApostrophe

protected static final String PubidCharMinusApostrophe

See Also:

Constant Field Values

NCNameStartChar

protected static final String NCNameStartChar

[4] NCNameStartChar ::= [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]

See Also:

Constant Field Values

NCNameChar

protected static final String NCNameChar

[4a] NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]

See Also:

Constant Field Values

inputReader

protected org.vesalainen.parser.util.InputReader inputReader

input

protected InputSource input

locator

protected XMLLocator locator

generalReferences

protected Map<String,Object> generalReferences

parameterReferences

protected Map<String,Object> parameterReferences

external

protected boolean external

Constructor Detail

XMLBaseGrammar

public XMLBaseGrammar()

Method Detail

parseExtSubset

protected abstract void parseExtSubset(org.vesalainen.parser.util.InputReader reader)

Parameters:

reader -

See Also:

BNF Syntax for extSubset

parseDocument

protected abstract void parseDocument(org.vesalainen.parser.util.InputReader reader)

Parameters:

reader -

See Also:

BNF Syntax for document

parseQuotAttValue

protected abstract String parseQuotAttValue(org.vesalainen.parser.util.InputReader reader)

Parameters:

reader -

Returns:

See Also:

BNF Syntax for quotAttValueSub

parseAposAttValue

protected abstract String parseAposAttValue(org.vesalainen.parser.util.InputReader reader)

Parameters:

reader -

Returns:

See Also:

BNF Syntax for aposAttValueSub

parseQuotEntityValue

protected abstract String parseQuotEntityValue(org.vesalainen.parser.util.InputReader reader)

Parameters:

reader -

Returns:

See Also:

BNF Syntax for quotEntityValueSub

parseAposEntityValue

protected abstract String parseAposEntityValue(org.vesalainen.parser.util.InputReader reader)

Parameters:

reader -

Returns:

See Also:

BNF Syntax for aposEntityValueSub

document

protected abstract void document()
                          throws SAXException

[1] document ::= ( prolog element Misc* ) - ( Char* RestrictedChar Char* )

Throws:

SAXException

name

protected abstract String name(String name)

[5] Name ::= NameStartChar (NameChar)*

Parameters:

name -

Returns:

names

protected List<String> names(String name)

[6] Names ::= Name (#x20 Name)*

names

protected List<String> names(List<String> names,
                 String name)

nmtoken

protected abstract String nmtoken(String nmtoken)

[7] Nmtoken ::= (NameChar)+

nmtokens

protected List<String> nmtokens(String nmtoken)

[8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*

nmtokens

protected List<String> nmtokens(List<String> nmtokens,
                    String nmtoken)

quotEntityValueStart

protected String quotEntityValueStart(org.vesalainen.parser.util.InputReader reader)
                               throws IOException

[9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"

Throws:

IOException

aposEntityValueStart

protected String aposEntityValueStart(org.vesalainen.parser.util.InputReader reader)
                               throws IOException

Throws:

IOException

entityValue

protected String entityValue(String str)
                      throws IOException

Throws:

IOException

quotEntityValueSub

protected String quotEntityValueSub(String str)

aposEntityValueSub

protected String aposEntityValueSub(String str)

quotEntityValue

protected String quotEntityValue()

aposEntityValue

protected String aposEntityValue()

quotEntityValue

protected String quotEntityValue(String str,
                     String value)

aposEntityValue

protected String aposEntityValue(String str,
                     String value)

quotAttValueStart

protected String quotAttValueStart(org.vesalainen.parser.util.InputReader reader)
                            throws IOException

[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'"

Throws:

IOException

aposAttValueStart

protected String aposAttValueStart(org.vesalainen.parser.util.InputReader reader)
                            throws IOException

Throws:

IOException

attValue

protected String attValue(String str)
                   throws IOException

Throws:

IOException

singleQuot

protected abstract void singleQuot()

singleApostrophe

protected abstract void singleApostrophe()

quotAttValueSub

protected String quotAttValueSub(String str)

aposAttValueSub

protected String aposAttValueSub(String str)

quotAttValue

protected String quotAttValue()

aposAttValue

protected String aposAttValue()

quotAttValue

protected String quotAttValue(String str,
                  String value)

aposAttValue

protected String aposAttValue(String str,
                  String value)

emptyQuote

protected String emptyQuote()

systemLiteral

protected String systemLiteral(String literal)

[11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

pubidLiteral

protected abstract String pubidLiteral(String literal)

[12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"

notQuotValue

protected abstract String notQuotValue(String value)

notAposValue

protected abstract String notAposValue(String value)

notQuot

protected abstract String notQuot(String value)

notApos

protected abstract String notApos(String value)

pubidLiteralWithApostrophe

protected String pubidLiteralWithApostrophe(String value)

pubidLiteralMinusApostrophe

protected String pubidLiteralMinusApostrophe(String value)

charData

protected void charData(org.vesalainen.parser.util.InputReader reader)
                 throws SAXException

[14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)

Throws:

SAXException

comment

protected void comment(org.vesalainen.parser.util.InputReader reader)
                throws SAXException

[15] Comment ::= ''

Throws:

SAXException

s

protected abstract void s()

pi

protected void pi()

[16] PI ::= '' Char*)))? '?>'

cdSect

protected void cdSect(org.vesalainen.parser.util.InputReader r)
               throws SAXException

[20] CData ::= (Char* - (Char* ']]>' Char*))

Throws:

SAXException

digit

protected abstract int digit(int value)

hex

protected int hex(String value)

xmlDecl

protected abstract void xmlDecl()

[23] XMLDecl ::= ''

byteOrderMark

protected abstract void byteOrderMark()

utf32BE

protected void utf32BE()
                throws SAXParseException

Throws:

SAXParseException

utf32LE

protected void utf32LE()
                throws SAXParseException

Throws:

SAXParseException

utf16BE

protected void utf16BE()
                throws SAXParseException

Throws:

SAXParseException

utf16LE

protected void utf16LE()
                throws SAXParseException

Throws:

SAXParseException

utf8

protected void utf8()
             throws SAXParseException

Throws:

SAXParseException

xmlPrefix

protected abstract void xmlPrefix()

utf32BEPrefix

protected void utf32BEPrefix()
                      throws SAXParseException

Throws:

SAXParseException

utf32LEPrefix

protected void utf32LEPrefix()
                      throws SAXParseException

Throws:

SAXParseException

utf16BEPrefix

protected void utf16BEPrefix()
                      throws SAXParseException

Throws:

SAXParseException

utf16LEPrefix

protected void utf16LEPrefix()
                      throws SAXParseException

Throws:

SAXParseException

utf8Prefix

protected abstract void utf8Prefix()

versionInfo

protected void versionInfo(String version)
                    throws SAXParseException

[24] VersionInfo ::= S 'version' Eq ("'" VersionNum "'" | '"' VersionNum '"')

Throws:

SAXParseException

versionNum

protected abstract String versionNum(String version)

[26] VersionNum ::= '1.1'

version

protected String version(String version)

eq

protected abstract void eq()

[25] Eq ::= S? '=' S?

misc

protected abstract void misc()

[27] Misc ::= Comment | PI | S

sdDecl

protected void sdDecl(boolean opt)

[32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"'))

yesNo

protected boolean yesNo(String opt)

charRef

protected String charRef(int value)

[66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'

Parameters:

value -

Returns:

charRefDecimal

protected int charRefDecimal(String s)

charRefHex

protected int charRefHex(String s)

reference

protected abstract String reference(String value)

[67] Reference ::= EntityRef | CharRef

Parameters:

value -

Returns:

entityRef

protected String entityRef(String name)
                    throws SAXParseException

[68] EntityRef ::= '&' Name ';'

Parameters:

name -

Returns:

Throws:

SAXParseException

peReference

protected String peReference(String name,
                 org.vesalainen.parser.util.InputReader reader)
                      throws SAXParseException,
                             IOException

[69] PEReference ::= '%' Name ';'

Parameters:

name -

Returns:

Throws:

SAXParseException

IOException

entityDecl

protected abstract void entityDecl()

[70] EntityDecl ::= GEDecl | PEDecl

geDecl

protected void geDecl(String name)

[71] GEDecl ::= ''

Parameters:

name -

peDecl

protected void peDecl(String name,
          Object value)
               throws SAXException

[72] PEDecl ::= ''

Parameters:

name -

Throws:

SAXException

entityDef

protected void entityDef(String entityValue)

[73] EntityDef ::= EntityValue | (ExternalID NDataDecl?)

Parameters:

value -

entityDef

protected void entityDef(String[] externalID)

peDef

protected Object peDef(String entityValue)

[74] PEDef ::= EntityValue | ExternalID

Parameters:

value -

peDef

protected Object peDef(String[] externalID)
                throws SAXException,
                       IOException

Throws:

SAXException

IOException

optExternalID

protected String[] optExternalID()

(S ExternalID)?

Returns:

optExternalID

protected String[] optExternalID(String[] externalID)

externalID

protected String[] externalID(String systemLiteral)

externalID

protected String[] externalID(String pubidLiteral,
                  String systemLiteral)

nDataDecl

protected void nDataDecl(String name)

[76] NDataDecl ::= S 'NDATA' S Name

Parameters:

name -

encodingDecl

protected void encodingDecl(String charset)

[80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'" )

Parameters:

encName -

encName

protected abstract String encName(String name)

[81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*

Parameters:

name -

Returns:

notationDecl

protected void notationDecl(String name,
                String[] externalID)
                     throws SAXException

[82] NotationDecl ::= ''

Parameters:

name -

id -

Throws:

SAXException

notationDecl

protected void notationDecl(String name,
                String publicID)
                     throws SAXException

Throws:

SAXException

publicID

protected abstract String publicID(String id)

[83] PublicID ::= 'PUBLIC' S PubidLiteral

Parameters:

id -

Returns:

nsAttName

protected String nsAttName(String s)
                    throws IOException

[1] NSAttName ::= PrefixedAttName | DefaultAttName

Throws:

IOException

sTagName

protected QName sTagName(String s)
                  throws IOException

[4] NCName ::= NCNameStartChar NCNameChar*

Parameters:

name -

Returns:

Throws:

IOException

eTagName

protected QName eTagName(String s)
                  throws IOException

Throws:

IOException

qName

protected QName qName(String s)
               throws IOException

Throws:

IOException

eol

protected char[] eol()
              throws IOException

Throws:

IOException

getEncoding

public String getEncoding()

getPublicId

public String getPublicId()

setPublicId

public void setPublicId(String publicId)

getSystemId

public String getSystemId()

setSystemId

public void setSystemId(String systemId)
                 throws URISyntaxException

Throws:

URISyntaxException

getXmlVersion

public String getXmlVersion()

setXmlVersion

public void setXmlVersion(String xmlVersion)

setExternal

public void setExternal(boolean external)