com.aspc.commander.parser

Class XMLParser

java.lang.Object

com.aspc.commander.parser.XMLParser

All Implemented Interfaces:

Parser

public class XMLParser
extends java.lang.Object
implements Parser

XMLParser handles a command in xml format.
THREAD MODE: SINGLE-THREADED

Since:

October 13, 2005

Author:

luke

Constructor Summary

Constructors

Constructor and Description
XMLParser(Pattern pattern) Creates a new XMLParser with the given Pattern
XMLParser(java.lang.String pattern) Creates a new XMLParser using the given string as the command pattern.

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	getDocument() Gets the Document object of the parsed xml command
java.lang.String[]	getList(java.lang.String name) Gets the list of values for the given variable name
Pattern	getPattern() Gets the pattern for this parser
java.lang.String	getRawText() Gets the raw XML string for this command
java.lang.String	getType() Gets the Type of this command, which is also the code for the command.
java.lang.String	getVariable(java.lang.String name) Gets the variable value for the given variable name
java.lang.String	getVariable(java.lang.String name, java.lang.String defaultValue) Gets the variable value for the given variable name, if the value is blank, it will return the supplied default value.
int	getVariableInt(java.lang.String name, int defaultValue) Gets the integer value for the given variable name, if the variable is blank then default value is returned.
long	getVariableLong(java.lang.String name, long defaultValue) Gets the long value for the given variable name, if the variable is blank then the given default value is returned.
boolean	hasKeyWord(java.lang.String keyword) Does this command have the given keyword
void	parse(java.lang.String xml) Parses the given XML string to a Document representing the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLParser

public XMLParser(java.lang.String pattern)

Creates a new XMLParser using the given string as the command pattern.

Parameters:

pattern - the command pattern

XMLParser

public XMLParser(Pattern pattern)

Creates a new XMLParser with the given Pattern

Parameters:

pattern - the command Pattern

Method Detail

parse

public void parse(java.lang.String xml)
           throws java.lang.Exception

Parses the given XML string to a Document representing the command.

Specified by:

parse in interface Parser

Parameters:

xml - the XML string

Throws:

java.lang.Exception - a serious problem

hasKeyWord

public boolean hasKeyWord(java.lang.String keyword)
                   throws java.lang.Exception

Does this command have the given keyword

Specified by:

hasKeyWord in interface Parser

Parameters:

keyword - the keyword to check for

Returns:

boolean true if this command has the given keyword

Throws:

java.lang.Exception - exception

getType

public java.lang.String getType()

Gets the Type of this command, which is also the code for the command.

Specified by:

getType in interface Parser

Returns:

String the type of this command

getRawText

public java.lang.String getRawText()

Gets the raw XML string for this command

Specified by:

getRawText in interface Parser

Returns:

String the raw XML string

getVariable

public java.lang.String getVariable(java.lang.String name)
                             throws java.lang.Exception

Gets the variable value for the given variable name

Specified by:

getVariable in interface Parser

Parameters:

name - the name of the variable

Returns:

String the value of the variable

Throws:

java.lang.Exception - a serious problem

getVariable

public java.lang.String getVariable(java.lang.String name,
                                    java.lang.String defaultValue)
                             throws java.lang.Exception

Gets the variable value for the given variable name, if the value is blank, it will return the supplied default value.

Specified by:

getVariable in interface Parser

Parameters:

name - the name of the variable

defaultValue - the default value, returned if the value is blank

Returns:

String the value of the variable

Throws:

java.lang.Exception - a serious problem

getVariableInt

public int getVariableInt(java.lang.String name,
                          int defaultValue)
                   throws java.lang.Exception

Gets the integer value for the given variable name, if the variable is blank then default value is returned.

Specified by:

getVariableInt in interface Parser

Parameters:

name - the name of the variable

defaultValue - the default value of the variable

Returns:

the value of the variable

Throws:

java.lang.Exception - a serious problem

getVariableLong

public long getVariableLong(java.lang.String name,
                            long defaultValue)
                     throws java.lang.Exception

Gets the long value for the given variable name, if the variable is blank then the given default value is returned.

Specified by:

getVariableLong in interface Parser

Parameters:

name - the name of the variable to get

defaultValue - the default value for the variable

Returns:

long the value of the variable

Throws:

java.lang.Exception - a serious problem

getList

@Nonnull
public java.lang.String[] getList(java.lang.String name)
                                    throws java.lang.Exception

Gets the list of values for the given variable name

Specified by:

getList in interface Parser

Parameters:

name - the name of the variable to get

Returns:

String[] the list of values

Throws:

java.lang.Exception - a serious problem

getDocument

public org.w3c.dom.Document getDocument()

Gets the Document object of the parsed xml command

Returns:

Document the DOM Document instance

getPattern

public Pattern getPattern()

Gets the pattern for this parser

Returns:

Pattern the pattern for this parser