com.cometway.xml
Class XMLPropsList

java.lang.Object
  com.cometway.props.Props
      com.cometway.ak.Agent
          com.cometway.ak.ServiceAgent
              com.cometway.props.PropsListAgent
                  com.cometway.xml.XMLPropsList

All Implemented Interfaces:

AgentInterface, HasStateMachineModel

public class XMLPropsList
extends PropsListAgent

Field Summary

protected static boolean	ALPHABETIZED_PROPS
protected static java.lang.String	EOL
static java.lang.String	MIME_TYPE
protected static java.text.SimpleDateFormat	SDF
protected com.cometway.xml.XMLPropsList.ScheduledTask	task

Fields inherited from class com.cometway.props.PropsListAgent

propsList

Fields inherited from class com.cometway.ak.Agent

agent_id, agentController, CREATING_STATE, debugReporter, DESTROYED_STATE, DESTROYING_STATE, errorReporter, FAILED_STATE, printlnReporter, props, RUNNING_STATE, STARTING_STATE, STOPPED_STATE, STOPPING_STATE, warningReporter

Constructor Summary

XMLPropsList()

Method Summary

void	initProps() Default properties: service_name = database (name this PropsList registers with the Service Manager).
static java.util.Vector	loadFromFile(java.lang.String filename) Loads a Props List XML file into a Vector of Props.
protected void	loadPropsList()
static java.util.Vector	parseInputStream(java.io.InputStream in) Loads a Props List XML document into a Vector of Props.
void	savePropsList()
static void	saveToFile(java.lang.String filename, java.util.List propsList) Saves a Vector of Props to a XML file.
void	start() Creates a PropsChangeListener for this agent and registers with the Service Manager using service_name.
void	stop() Unregister this agent with the Service Manager and sets internal state variables to null.
static void	write(java.io.Writer out, java.util.List propsList) Outputs a Vector of Props as XML using the specificed Writer.

Methods inherited from class com.cometway.ak.Agent

currentStateEquals, debug, destroy, error, error, getAgentController, getDateTimeStr, getProps, getServiceImpl, getStateMachineModel, println, register, registerService, setAgentController, setProps, toString, unregister, unregisterService, warning, warning

Methods inherited from class com.cometway.props.Props

addListener, append, copy, copyFrom, copyTo, decrementInteger, dump, enableListeners, enumerateKeys, format, getBoolean, getByteArray, getCharacter, getDate, getDate, getDateString, getDouble, getFloat, getHexString, getInteger, getKeys, getLong, getNextKey, getProperty, getProperty, getPropsContainer, getSize, getString, getString, getTokens, getTokens, getTrimmedString, getVector, hasProperty, incrementInteger, insertProps, loadProps, notifyPropsChanged, notifyPropsChangedIgnore, notifyPropsChangedIgnore, parse, propertyMatchesRegEx, readFromFile, regExPropertyMatches, removeAll, removeListener, removeProperty, resumeNotify, saveProps, set, setBoolean, setCharacter, setDefault, setDouble, setFloat, setInteger, setLong, setProperty, setProperty, setProperty, setPropsContainer, suspendNotify, writeToFile

Methods inherited from class java.lang.Object

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

Field Detail

MIME_TYPE

public static final java.lang.String MIME_TYPE

See Also:

Constant Field Values

ALPHABETIZED_PROPS

protected static final boolean ALPHABETIZED_PROPS

See Also:

Constant Field Values

EOL

protected static final java.lang.String EOL

SDF

protected static final java.text.SimpleDateFormat SDF

task

protected com.cometway.xml.XMLPropsList.ScheduledTask task

Constructor Detail

XMLPropsList

public XMLPropsList()

Method Detail

initProps

public void initProps()

Description copied from class: PropsListAgent

Default properties:
 service_name = database (name this PropsList registers with the Service Manager).

Specified by:

initProps in interface AgentInterface

Overrides:

initProps in class PropsListAgent

start

public void start()

Description copied from class: PropsListAgent

Creates a PropsChangeListener for this agent and registers with the Service Manager using service_name.

Specified by:

start in interface AgentInterface

Overrides:

start in class PropsListAgent

stop

public void stop()

Description copied from class: PropsListAgent

Unregister this agent with the Service Manager and sets internal state variables to null. All Props references are permanently lost.

Specified by:

stop in interface AgentInterface

Overrides:

stop in class PropsListAgent

savePropsList

public void savePropsList()

loadPropsList

protected void loadPropsList()

parseInputStream

public static java.util.Vector parseInputStream(java.io.InputStream in)
                                         throws XMLParserException

Loads a Props List XML document into a Vector of Props.

Throws:

XMLParserException

loadFromFile

public static java.util.Vector loadFromFile(java.lang.String filename)
                                     throws PropsException

Loads a Props List XML file into a Vector of Props.

Throws:

PropsException

saveToFile

public static void saveToFile(java.lang.String filename,
                              java.util.List propsList)
                       throws PropsException

Saves a Vector of Props to a XML file.

Throws:

PropsException

write

public static void write(java.io.Writer out,
                         java.util.List propsList)
                  throws java.io.IOException

Outputs a Vector of Props as XML using the specificed Writer.

Throws:

java.io.IOException