|
Remote System Explorer DataStore Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.dstore.core.util.CommandGenerator
public class CommandGenerator
This class is used to generate command object instances from command descriptors and arguments to commands. Command instances are instances of command descriptors. Each command instance contains a set of data arguments and a status object, that represents the current state of a command. After a command instance is created, it is referenced in the command log for the DataStore.
Constructor Summary | |
---|---|
CommandGenerator()
Constructor |
Method Summary | |
---|---|
DataElement |
createCommand(DataElement commandDescriptor)
Creates a new command instance object from a command descriptor |
DataElement |
generateCommand(DataElement commandDescriptor,
ArrayList arguments,
DataElement dataObject,
boolean refArg)
Creates a new command from a command descriptor and it's arguments. |
DataElement |
generateCommand(DataElement commandDescriptor,
DataElement dataObject,
boolean refArg)
Creates a new command from a command descriptor and it's arguments. |
DataElement |
generateCommand(DataElement commandDescriptor,
DataElement arg,
DataElement dataObject,
boolean refArg)
Creates a new command from a command descriptor and it's arguments. |
DataElement |
generateResponse(DataElement document,
ArrayList objects)
Creates a response tree for transmitting a set of data from a server to a client. |
DataElement |
generateResponse(String responseType)
Creates a simple response object of the specified type |
DataElement |
generateResponse(String responseType,
DataElement dataObject)
Creates a response tree for transmitting a set of data from a server to a client. |
DataElement |
logCommand(DataElement commandObject)
This method logs the current command object in the DataStore command log. |
void |
setDataStore(DataStore dataStore)
Sets the associated DataStore |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CommandGenerator()
Method Detail |
---|
public void setDataStore(DataStore dataStore)
dataStore
- the associated DataStorepublic DataElement logCommand(DataElement commandObject)
commandObject
- the commandObject to log
public DataElement createCommand(DataElement commandDescriptor)
commandDescriptor
- the descriptor of the command to create
public DataElement generateCommand(DataElement commandDescriptor, ArrayList arguments, DataElement dataObject, boolean refArg)
commandDescriptor
- the command type of the new commandarguments
- the arguments for the command, besides the subjectdataObject
- the subject of the commandrefArg
- indicates whether the subject should be represented as a reference or directly
public DataElement generateCommand(DataElement commandDescriptor, DataElement arg, DataElement dataObject, boolean refArg)
commandDescriptor
- the command type of the new commandarg
- the arguement for the command, besides the subjectdataObject
- the subject of the commandrefArg
- indicates whether the subject should be represented as a reference or directly
public DataElement generateCommand(DataElement commandDescriptor, DataElement dataObject, boolean refArg)
commandDescriptor
- the command type of the new commanddataObject
- the subject of the commandrefArg
- indicates whether the subject should be represented as a reference or directly
public DataElement generateResponse(DataElement document, ArrayList objects)
document
- the root of the responseobjects
- the data contained in the response
public DataElement generateResponse(String responseType, DataElement dataObject)
responseType
- the type of data to respond withdataObject
- the child object in the response tree
public DataElement generateResponse(String responseType)
responseType
- the type of data to respond with
|
Remote System Explorer DataStore Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |