com.planet_ink.coffee_mud.Libraries.interfaces
Interface XMLLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

XMLManager

public interface XMLLibrary
extends CMLibrary

Nested Class Summary

static interface

XMLLibrary.XMLTag

Field Summary

static java.lang.String

FILE_XML_BOUNDARY

Method Summary

java.lang.String	convertXMLtoTag(java.lang.String TName, boolean Data) Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);
java.lang.String	convertXMLtoTag(java.lang.String TName, int Data) Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);
java.lang.String	convertXMLtoTag(java.lang.String TName, long Data) Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);
java.lang.String	convertXMLtoTag(java.lang.String TName, short Data) Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);
java.lang.String	convertXMLtoTag(java.lang.String TName, java.lang.String Data) Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);
XMLLibrary.XMLTag	createNewTag(java.lang.String key, java.lang.String value) Create a new tag, just like the XML Manager does.
java.lang.String	fromPOJOtoXML(java.lang.Object o) Converts a pojo object to a XML document.
java.util.Map<java.lang.String,java.lang.String>	fromXML(java.lang.String str) Converts a map into an xml document
void	fromXMLtoPOJO(java.util.List<XMLLibrary.XMLTag> xmlObj, java.lang.Object o) Converts a xml object to a pojo object.
void	fromXMLtoPOJO(java.lang.String XML, java.lang.Object o) Converts a xml document to a XML object.
boolean	getBoolFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");
boolean	getBoolFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag, boolean defValue) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");
java.util.List<XMLLibrary.XMLTag>	getContentsFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Returns the contents of a container tag, searched for in another container tags contents
double	getDoubleFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");
double	getDoubleFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag, double defVal) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");
int	getIntFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");
int	getIntFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag, int defVal) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");
long	getLongFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");
long	getLongFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag, long defVal) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");
XMLLibrary.XMLTag	getPieceFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Returns the xml tag node for the given tag name, if found in the given tag container contents
java.util.List<XMLLibrary.XMLTag>	getPiecesFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Returns all tags inside the gives set that match this tag name
short	getShortFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");
short	getShortFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag, short defVal) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");
java.lang.String	getValFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Returns the value of the tag, if it exists in the given tag collection
java.lang.String	getValFromPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag, java.lang.String defValue) Returns the value of the tag, if it exists in the given tag collection
java.lang.String	getXMLList(java.util.List<java.lang.String> V) Converts the given list of strings into a set of top-level xml tags called simply <X>
boolean	isTagInPieces(java.util.List<XMLLibrary.XMLTag> V, java.lang.String tag) Return where the value is within a given XML block <TAG>Data</TAG> Usage: boolean ThisColHead=isTagInPieces(ThisRow,"TD");
java.util.List<XMLLibrary.XMLTag>	parseAllXML(java.lang.String buf) Parses all xml inside the given string buffer and returns the root tags as a container collection.
java.util.List<XMLLibrary.XMLTag>	parseAllXML(java.lang.StringBuffer buf) Parses all xml inside the given stringbuffer and returns the root tags as a container collection.
java.lang.String	parseOutAngleBrackets(java.lang.String s) parse a tag value for safety Usage: String val=parseOutAngleBrackets(ThisValue);
java.lang.String	parseOutAngleBracketsAndQuotes(java.lang.String s) parse a tag value for safety Usage: String val=parseOutAngleBracketsAndQuotes(ThisValue);
java.util.List<java.lang.String>	parseXMLList(java.lang.String numberedList) Parses a list of single-level xml tags, together in string.
java.lang.String	restoreAngleBrackets(java.lang.String s) restore a tag value parsed for safety Usage: String val=restoreAngleBrackets(ThisValue);
java.lang.String	returnXMLBlock(java.lang.String Blob, java.lang.String Tag) Return the contents of an XML tag, given the tag to search for Usage: String XML=returnXMLBlock(Response,"PDIModelErrors");
boolean	returnXMLBoolean(java.lang.String Blob, java.lang.String Tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=returnXMLValue(ThisRow,"TD");
java.lang.String	returnXMLValue(java.lang.String Blob) Return the data value within the first XML block <TAG>Data</TAG> Usage: String ThisColHead=returnXMLValue(ThisRow);
java.lang.String	returnXMLValue(java.lang.String Blob, java.lang.String Tag) Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=returnXMLValue(ThisRow,"TD");
java.lang.String	toXML(java.util.Map<java.lang.String,java.lang.String> map) Converts a map into an xml document

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

FILE_XML_BOUNDARY

static final java.lang.String FILE_XML_BOUNDARY

See Also:

Constant Field Values

Method Detail

convertXMLtoTag

java.lang.String convertXMLtoTag(java.lang.String TName,
                                 java.lang.String Data)

Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);

Parameters:

TName - Tag name to use

Data - the data

Returns:

String Information corresponding to the tname

convertXMLtoTag

java.lang.String convertXMLtoTag(java.lang.String TName,
                                 int Data)

Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);

Parameters:

TName - Tag name to use

Data - the data

Returns:

String Information corresponding to the tname

convertXMLtoTag

java.lang.String convertXMLtoTag(java.lang.String TName,
                                 short Data)

Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);

Parameters:

TName - Tag name to use

Data - the data

Returns:

String Information corresponding to the tname

convertXMLtoTag

java.lang.String convertXMLtoTag(java.lang.String TName,
                                 boolean Data)

Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);

Parameters:

TName - Tag name to use

Data - the data

Returns:

String Information corresponding to the tname

convertXMLtoTag

java.lang.String convertXMLtoTag(java.lang.String TName,
                                 long Data)

Return the outer wrapper and contents of an XML tag <TNAME>Data</TNAME> Usage: Data+=XMLoTag("MODELOBJECTONE",VA.ModelObjectOne);

Parameters:

TName - Tag name to use

Data - the data

Returns:

String Information corresponding to the tname

returnXMLBlock

java.lang.String returnXMLBlock(java.lang.String Blob,
                                java.lang.String Tag)

Return the contents of an XML tag, given the tag to search for Usage: String XML=returnXMLBlock(Response,"PDIModelErrors");

Parameters:

Blob - String to searh

Tag - Tag name to search for

Returns:

String Information corresponding to the tname

parseAllXML

java.util.List<XMLLibrary.XMLTag> parseAllXML(java.lang.String buf)

Parses all xml inside the given string buffer and returns the root tags as a container collection.

Parameters:

buf - the string to parse

Returns:

the parsed xml

parseAllXML

java.util.List<XMLLibrary.XMLTag> parseAllXML(java.lang.StringBuffer buf)

Parses all xml inside the given stringbuffer and returns the root tags as a container collection.

Parameters:

buf - the string to parse

Returns:

the parsed xml

parseXMLList

java.util.List<java.lang.String> parseXMLList(java.lang.String numberedList)

Parses a list of single-level xml tags, together in string. This method assumes that the given string is a series of top level tags, with no child tags, and no attributes. It will parse the tags, and return their values (only) as a list of strings. Any deconversions for compatibility are also performed

Parameters:

numberedList - the top level xml tags

Returns:

the list of strings with the values of those tags

getXMLList

java.lang.String getXMLList(java.util.List<java.lang.String> V)

Converts the given list of strings into a set of top-level xml tags called simply <X>

Parameters:

V - the list of strings

Returns:

the top level xml tags

returnXMLValue

java.lang.String returnXMLValue(java.lang.String Blob)

Return the data value within the first XML block <TAG>Data</TAG> Usage: String ThisColHead=returnXMLValue(ThisRow);

Parameters:

Blob - String to searh

Returns:

String Information from first XML block

returnXMLValue

java.lang.String returnXMLValue(java.lang.String Blob,
                                java.lang.String Tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=returnXMLValue(ThisRow,"TD");

Parameters:

Blob - String to search

Tag - Tag to search for

Returns:

String Information from XML block

returnXMLBoolean

boolean returnXMLBoolean(java.lang.String Blob,
                         java.lang.String Tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=returnXMLValue(ThisRow,"TD");

Parameters:

Blob - String to search

Tag - Tag to search for

Returns:

String Information from XML block

parseOutAngleBrackets

java.lang.String parseOutAngleBrackets(java.lang.String s)

parse a tag value for safety Usage: String val=parseOutAngleBrackets(ThisValue);

Parameters:

s - String to parse

Returns:

String parsed value

parseOutAngleBracketsAndQuotes

java.lang.String parseOutAngleBracketsAndQuotes(java.lang.String s)

parse a tag value for safety Usage: String val=parseOutAngleBracketsAndQuotes(ThisValue);

Parameters:

s - String to parse

Returns:

String parsed value

restoreAngleBrackets

java.lang.String restoreAngleBrackets(java.lang.String s)

restore a tag value parsed for safety Usage: String val=restoreAngleBrackets(ThisValue);

Parameters:

s - String to parse

Returns:

String unparsed value

createNewTag

XMLLibrary.XMLTag createNewTag(java.lang.String key,
                               java.lang.String value)

Create a new tag, just like the XML Manager does.

Parameters:

key - the tag name/key

value - the value of the inside of the tag, if any.

Returns:

the new tag object

getContentsFromPieces

java.util.List<XMLLibrary.XMLTag> getContentsFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                                                        java.lang.String tag)

Returns the contents of a container tag, searched for in another container tags contents

Parameters:

V - the container tags contents

tag - the tag to look for

Returns:

the tags contained in tag, or null

getPiecesFromPieces

java.util.List<XMLLibrary.XMLTag> getPiecesFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                                                      java.lang.String tag)

Returns all tags inside the gives set that match this tag name

Parameters:

V - the container tags contents

tag - the tag to look for

Returns:

all the tags contained in tag

getPieceFromPieces

XMLLibrary.XMLTag getPieceFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                                     java.lang.String tag)

Returns the xml tag node for the given tag name, if found in the given tag container contents

Parameters:

V - the tag container contents

tag - the tag name

Returns:

the xml tag node for the given tag name

getValFromPieces

java.lang.String getValFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                                  java.lang.String tag)

Returns the value of the tag, if it exists in the given tag collection

Parameters:

V - the tag collection (container tag)

tag - the tag to look for

Returns:

its value, or null

getBoolFromPieces

boolean getBoolFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                          java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

Returns:

boolean Information from XML block

getShortFromPieces

short getShortFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                         java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

Returns:

short Information from XML block

getIntFromPieces

int getIntFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                     java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

Returns:

int Information from XML block

isTagInPieces

boolean isTagInPieces(java.util.List<XMLLibrary.XMLTag> V,
                      java.lang.String tag)

Return where the value is within a given XML block <TAG>Data</TAG> Usage: boolean ThisColHead=isTagInPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

Returns:

boolean Information from XML block

getLongFromPieces

long getLongFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                       java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

Returns:

long Information from XML block

getDoubleFromPieces

double getDoubleFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                           java.lang.String tag)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

Returns:

double Information from XML block

getValFromPieces

java.lang.String getValFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                                  java.lang.String tag,
                                  java.lang.String defValue)

Returns the value of the tag, if it exists in the given tag collection

Parameters:

V - the tag collection (container tag)

tag - the tag to look for

defValue - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getBoolFromPieces

boolean getBoolFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                          java.lang.String tag,
                          boolean defValue)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getBoolFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

defValue - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getShortFromPieces

short getShortFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                         java.lang.String tag,
                         short defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getShortFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getIntFromPieces

int getIntFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                     java.lang.String tag,
                     int defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getIntFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getLongFromPieces

long getLongFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                       java.lang.String tag,
                       long defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getLongFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

getDoubleFromPieces

double getDoubleFromPieces(java.util.List<XMLLibrary.XMLTag> V,
                           java.lang.String tag,
                           double defVal)

Return the data value within a given XML block <TAG>Data</TAG> Usage: String ThisColHead=getDoubleFromPieces(ThisRow,"TD");

Parameters:

V - Pieces to search

tag - Tag to search for

defVal - the value to return if the tag doesn't exist

Returns:

the tags value, or defValue

fromPOJOtoXML

java.lang.String fromPOJOtoXML(java.lang.Object o)

Converts a pojo object to a XML document.

Parameters:

o - the object to convert

Returns:

the XML document

fromXMLtoPOJO

void fromXMLtoPOJO(java.lang.String XML,
                   java.lang.Object o)

Converts a xml document to a XML object.

Parameters:

XML - the XML document

o - the object to convert

fromXMLtoPOJO

void fromXMLtoPOJO(java.util.List<XMLLibrary.XMLTag> xmlObj,
                   java.lang.Object o)

Converts a xml object to a pojo object.

Parameters:

xmlObj - the xml object

o - the object to convert

toXML

java.lang.String toXML(java.util.Map<java.lang.String,java.lang.String> map)

Converts a map into an xml document

Returns:

an xml document

fromXML

java.util.Map<java.lang.String,java.lang.String> fromXML(java.lang.String str)

Converts a map into an xml document

Returns:

an xml document