|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object eu.semaine.datatypes.stateinfo.StateInfo
public abstract class StateInfo
A class representing one of the information states. It can be created either from an XML document or from a Map of information items, and can be read either as an XML document or as a Map of information items.
Nested Class Summary | |
---|---|
static class |
StateInfo.Type
|
static class |
StateInfo.XPathInfoMapper
A helper class that supports us in mapping short names to XPath expressions. |
Field Summary | |
---|---|
static java.lang.String |
APIVersion
|
protected org.w3c.dom.Document |
doc
|
protected java.util.Map<java.lang.String,java.lang.String> |
info
|
static java.util.Map<StateInfo.Type,StateInfo.XPathInfoMapper> |
infosByType
|
protected JMSLogger |
log
|
protected java.lang.String |
stateName
|
protected StateInfo.Type |
type
|
Constructor Summary | |
---|---|
protected |
StateInfo(org.w3c.dom.Document doc,
java.lang.String whatState,
java.lang.String rootName,
java.lang.String rootNamespace,
StateInfo.Type type)
|
|
StateInfo(java.util.Map<java.lang.String,java.lang.String> infoItems,
java.lang.String whatState,
StateInfo.Type type)
|
Method Summary | |
---|---|
protected void |
analyseDocument(java.lang.String rootName,
java.lang.String rootNamespace)
Read information from the message document and fill our info as much as possible. |
protected void |
createDocumentFromInfo()
|
java.lang.String |
getAPIVersion()
|
org.w3c.dom.Document |
getDocument()
|
java.lang.String |
getInfo(java.lang.String name)
Get the named information, or null if there is no such information. |
java.util.Map<java.lang.String,java.lang.String> |
getInfos()
Provide a read-only access to the information in this message. |
StateInfo.Type |
getType()
Get the type of state info of this object: AgentState, DialogState, UserState, ContextState, or SystemState. |
protected static StateInfo.XPathInfoMapper |
getXPathExpressions(StateInfo.Type typeForTable,
java.util.List<java.lang.String> configSection)
|
boolean |
hasInfo(java.lang.String name)
Indicate whether the current info set contains an entry for the named information. |
void |
setInfo(java.lang.String name,
java.lang.String value)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String APIVersion
public static final java.util.Map<StateInfo.Type,StateInfo.XPathInfoMapper> infosByType
protected java.util.Map<java.lang.String,java.lang.String> info
protected org.w3c.dom.Document doc
protected JMSLogger log
protected java.lang.String stateName
protected StateInfo.Type type
Constructor Detail |
---|
protected StateInfo(org.w3c.dom.Document doc, java.lang.String whatState, java.lang.String rootName, java.lang.String rootNamespace, StateInfo.Type type) throws MessageFormatException
MessageFormatException
public StateInfo(java.util.Map<java.lang.String,java.lang.String> infoItems, java.lang.String whatState, StateInfo.Type type) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
Method Detail |
---|
protected static StateInfo.XPathInfoMapper getXPathExpressions(StateInfo.Type typeForTable, java.util.List<java.lang.String> configSection) throws SystemConfigurationException
SystemConfigurationException
public StateInfo.Type getType()
protected void createDocumentFromInfo() throws SystemConfigurationException
SystemConfigurationException
protected void analyseDocument(java.lang.String rootName, java.lang.String rootNamespace) throws MessageFormatException
MessageFormatException
- if the structure of the document is
inconsistent, i.e. structure expectations are violated.public java.util.Map<java.lang.String,java.lang.String> getInfos()
public boolean hasInfo(java.lang.String name)
name
-
public java.lang.String getInfo(java.lang.String name)
name
-
public void setInfo(java.lang.String name, java.lang.String value)
public org.w3c.dom.Document getDocument()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getAPIVersion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |