dip.world.variant.parser
Class XMLVariantParser

java.lang.Object
  dip.world.variant.parser.XMLVariantParser

All Implemented Interfaces:

VariantParser

public class XMLVariantParser

extends java.lang.Object

implements VariantParser

Parses an XML Variant description.

Field Summary

static java.lang.String	ATT_ACTIVE
static java.lang.String	ATT_ADJACENCYURI
static java.lang.String	ATT_ADJECTIVE
static java.lang.String	ATT_ALIASES
static java.lang.String	ATT_ALLOW_BC_YEARS
static java.lang.String	ATT_ALTNAMES
static java.lang.String	ATT_DEFAULT
static java.lang.String	ATT_DESCRIPTION
static java.lang.String	ATT_HOMEPOWER
static java.lang.String	ATT_ID
static java.lang.String	ATT_NAME
static java.lang.String	ATT_OWNER
static java.lang.String	ATT_POWER
static java.lang.String	ATT_PREFERRED_UNIT_STYLE
static java.lang.String	ATT_PROVINCE
static java.lang.String	ATT_REF
static java.lang.String	ATT_THUMBURI
static java.lang.String	ATT_TITLE
static java.lang.String	ATT_TURN
static java.lang.String	ATT_UNIT
static java.lang.String	ATT_UNITCOAST
static java.lang.String	ATT_URI
static java.lang.String	ATT_VALUE
static java.lang.String	ATT_VERSION
static java.lang.String	EL_DESCRIPTION
static java.lang.String	EL_GAME_LENGTH
static java.lang.String	EL_INITIALSTATE
static java.lang.String	EL_MAP
static java.lang.String	EL_MAP_DEFINITION
static java.lang.String	EL_MAP_GRAPHIC
static java.lang.String	EL_POWER
static java.lang.String	EL_RULEOPTION
static java.lang.String	EL_RULEOPTIONS
static java.lang.String	EL_STARTINGTIME
static java.lang.String	EL_SUPPLYCENTER
static java.lang.String	EL_VARIANT
static java.lang.String	EL_VARIANTS
static java.lang.String	EL_VICTORYCONDITIONS
static java.lang.String	EL_WINNING_SUPPLY_CENTERS
static java.lang.String	EL_YEARS_WITHOUT_SC_CAPTURE

Constructor Summary

XMLVariantParser(javax.xml.parsers.DocumentBuilderFactory dbf)
Create an XMLVariantParser

Method Summary

void	close() Cleanup, clearing any references/resources
Variant[]	getVariants() Returns an array of Variant objects.
void	parse(java.io.InputStream is, java.net.URL variantPackageURL) Parse the given input stream; parsed data available via getVariants() Note that when this method is called, any previous Variants (if any exist) are cleared.

Methods inherited from class java.lang.Object

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

Field Detail

EL_VARIANTS

public static final java.lang.String EL_VARIANTS

See Also:

Constant Field Values

EL_VARIANT

public static final java.lang.String EL_VARIANT

See Also:

Constant Field Values

EL_DESCRIPTION

public static final java.lang.String EL_DESCRIPTION

See Also:

Constant Field Values

EL_MAP

public static final java.lang.String EL_MAP

See Also:

Constant Field Values

EL_STARTINGTIME

public static final java.lang.String EL_STARTINGTIME

See Also:

Constant Field Values

EL_INITIALSTATE

public static final java.lang.String EL_INITIALSTATE

See Also:

Constant Field Values

EL_SUPPLYCENTER

public static final java.lang.String EL_SUPPLYCENTER

See Also:

Constant Field Values

EL_POWER

public static final java.lang.String EL_POWER

See Also:

Constant Field Values

EL_MAP_DEFINITION

public static final java.lang.String EL_MAP_DEFINITION

See Also:

Constant Field Values

EL_MAP_GRAPHIC

public static final java.lang.String EL_MAP_GRAPHIC

See Also:

Constant Field Values

EL_VICTORYCONDITIONS

public static final java.lang.String EL_VICTORYCONDITIONS

See Also:

Constant Field Values

EL_GAME_LENGTH

public static final java.lang.String EL_GAME_LENGTH

See Also:

Constant Field Values

EL_YEARS_WITHOUT_SC_CAPTURE

public static final java.lang.String EL_YEARS_WITHOUT_SC_CAPTURE

See Also:

Constant Field Values

EL_WINNING_SUPPLY_CENTERS

public static final java.lang.String EL_WINNING_SUPPLY_CENTERS

See Also:

Constant Field Values

EL_RULEOPTIONS

public static final java.lang.String EL_RULEOPTIONS

See Also:

Constant Field Values

EL_RULEOPTION

public static final java.lang.String EL_RULEOPTION

See Also:

Constant Field Values

ATT_ALIASES

public static final java.lang.String ATT_ALIASES

See Also:

Constant Field Values

ATT_VERSION

public static final java.lang.String ATT_VERSION

See Also:

Constant Field Values

ATT_URI

public static final java.lang.String ATT_URI

See Also:

Constant Field Values

ATT_DEFAULT

public static final java.lang.String ATT_DEFAULT

See Also:

Constant Field Values

ATT_TITLE

public static final java.lang.String ATT_TITLE

See Also:

Constant Field Values

ATT_DESCRIPTION

public static final java.lang.String ATT_DESCRIPTION

See Also:

Constant Field Values

ATT_THUMBURI

public static final java.lang.String ATT_THUMBURI

See Also:

Constant Field Values

ATT_ADJACENCYURI

public static final java.lang.String ATT_ADJACENCYURI

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

See Also:

Constant Field Values

ATT_ACTIVE

public static final java.lang.String ATT_ACTIVE

See Also:

Constant Field Values

ATT_ADJECTIVE

public static final java.lang.String ATT_ADJECTIVE

See Also:

Constant Field Values

ATT_ALTNAMES

public static final java.lang.String ATT_ALTNAMES

See Also:

Constant Field Values

ATT_TURN

public static final java.lang.String ATT_TURN

See Also:

Constant Field Values

ATT_VALUE

public static final java.lang.String ATT_VALUE

See Also:

Constant Field Values

ATT_PROVINCE

public static final java.lang.String ATT_PROVINCE

See Also:

Constant Field Values

ATT_HOMEPOWER

public static final java.lang.String ATT_HOMEPOWER

See Also:

Constant Field Values

ATT_OWNER

public static final java.lang.String ATT_OWNER

See Also:

Constant Field Values

ATT_POWER

public static final java.lang.String ATT_POWER

See Also:

Constant Field Values

ATT_UNIT

public static final java.lang.String ATT_UNIT

See Also:

Constant Field Values

ATT_UNITCOAST

public static final java.lang.String ATT_UNITCOAST

See Also:

Constant Field Values

ATT_ALLOW_BC_YEARS

public static final java.lang.String ATT_ALLOW_BC_YEARS

See Also:

Constant Field Values

ATT_PREFERRED_UNIT_STYLE

public static final java.lang.String ATT_PREFERRED_UNIT_STYLE

See Also:

Constant Field Values

ATT_ID

public static final java.lang.String ATT_ID

See Also:

Constant Field Values

ATT_REF

public static final java.lang.String ATT_REF

See Also:

Constant Field Values

Constructor Detail

XMLVariantParser

public XMLVariantParser(javax.xml.parsers.DocumentBuilderFactory dbf)
                 throws javax.xml.parsers.ParserConfigurationException

Create an XMLVariantParser

Method Detail

parse

public void parse(java.io.InputStream is,
                  java.net.URL variantPackageURL)
           throws java.io.IOException,
                  org.xml.sax.SAXException

Parse the given input stream; parsed data available via getVariants()

Note that when this method is called, any previous Variants (if any exist) are cleared.

Throws:

java.io.IOException

org.xml.sax.SAXException

close

public void close()

Cleanup, clearing any references/resources

getVariants

public Variant[] getVariants()

Returns an array of Variant objects.

Will never return null. Note that parse() must be called before this will return any information.

Specified by:

getVariants in interface VariantParser