at.srfg.miner.clientlib

Class Scenario

Object

at.srfg.miner.clientlib.Scenario

public class Scenario
extends Object

A MINER Scenario is the root element of a scenario specification. The following table lists the required and optional properties of a Scenario.

Required?	Name	Description	Quantity
yes	name	The name of the Scenario	1
yes	task	A MINER Task	1..N
no	description	The description of the Scenario	0..1
no	keyword	Multiple keywords can be assigned to a Scenario	0..N

Constructor Summary

Constructors

Constructor and Description
Scenario(String scenarioName) Creates a new scenario and sets the scenario name.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyword(String keyword) Adds a keyword to the scenario.
Task	addTask() Creates a new MINER task and adds it to this scenario.
Task	addTask(String name) Creates a new MINER task with the given name and adds it to this scenario.
Task	addTask(Task task) Adds a MINER task to this scenario.
void	delete() Deletes the scenario, its executions incl. their results at the MINER Core.
Execution	execute() Executes the scenario immediately and without a defined stop time.
Execution	execute(int duration) Executes the scenario immediately for the given duration.
Execution	execute(int duration, String description) Executes the scenario immediately for the given duration.
Execution	execute(String description) Executes the scenario immediately and without a defined stop time.
Collection<ResultHandle>	getAllResultHandles() Gets all ResultHandles that are defined in this scenario.
Date	getCreated() Gets the date when the scenario was created at the MINER core.
String	getDescription() Gets the description of the scenario.
int	getID() Gets the ID that identifies the Scenario at the MINER core.
List<String>	getKeywords() Gets the keywords associated with this scenario.
Date	getModified() Gets the date when the scenario was last modified at the MINER core.
String	getName() Gets the name of the scenario.
ResultHandle	getResultHandleByName(String resultName) Searches the scenario for a ResultHandle called resultName.
Task	getTaskByName(String taskName) Searches for a task called taskName.
Collection<Task>	getTasks() Gets all the tasks contained in this scenario.
boolean	print() Prints an XML representation of the scenario to System.out.
boolean	print(java.io.OutputStream os) Prints an XML representation of the scenario to the given Outputstream os.
void	reuseAsNew() Enables the reuse of the scenario object for the specification of another scenario.
boolean	save(java.io.File file) Saves an XML representation of the scenario to file.
Execution	schedule(Date start) Schedules the scenario for execution.
Execution	schedule(Date start, Date stop) Schedules the scenario for execution.
Execution	schedule(Date start, Date stop, String description) Schedules the scenario for execution.
Execution	schedule(Date start, String description) Schedules the scenario for execution.
Execution	schedule(int offset) Executes the scenario offset [s] in the future and and without a defined stop time.
Execution	schedule(int offset, int duration) Executes the scenario offset [s] in the future and for the given duration.
Execution	schedule(int offset, int duration, String description) Executes the scenario offset [s] in the future and for the given duration.
Execution	schedule(int offset, String description) Executes the scenario offset [s] in the future and and without a defined stop time.
void	setDescription(String description) Sets a description for the scenario.
void	setName(String name) Sets the name of the scenario.
void	submit() Submits the scenario to the MINER core.
String	toXMLString() Converts the scenario to a String containing an XML representation of the scenario.

Methods inherited from class Object

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

Constructor Detail

Scenario

public Scenario(String scenarioName)

Creates a new scenario and sets the scenario name.

Parameters:

scenarioName - the scenario name

Method Detail

getDescription

public String getDescription()

Gets the description of the scenario.

Returns:

the description

setDescription

public void setDescription(String description)

Sets a description for the scenario.

Parameters:

description - the description

getName

public String getName()

Gets the name of the scenario.

Returns:

the name

setName

public void setName(String name)

Sets the name of the scenario.

Parameters:

name - the name

getKeywords

public List<String> getKeywords()

Gets the keywords associated with this scenario.

Returns:

a list of keywords

addKeyword

public void addKeyword(String keyword)

Adds a keyword to the scenario.

Parameters:

keyword - the keyword

getCreated

public Date getCreated()

Gets the date when the scenario was created at the MINER core.

Returns:

the date

getModified

public Date getModified()

Gets the date when the scenario was last modified at the MINER core.

Returns:

the date

addTask

public Task addTask()

Creates a new MINER task and adds it to this scenario.

Returns:

the newly created task

addTask

public Task addTask(String name)

Creates a new MINER task with the given name and adds it to this scenario.

Parameters:

name - the name of the task

Returns:

the newly created task

addTask

public Task addTask(Task task)

Adds a MINER task to this scenario.

Parameters:

task - the MINER Task

Returns:

the input parameter task

getTasks

public Collection<Task> getTasks()

Gets all the tasks contained in this scenario. Note that the result contains only those tasks that are not included by reference.

Returns:

the tasks

getID

public int getID()

Gets the ID that identifies the Scenario at the MINER core.

Returns:

the ID

reuseAsNew

public void reuseAsNew()

Enables the reuse of the scenario object for the specification of another scenario. This method has no effect if the scenario hasn't been submitted to the core before.

getAllResultHandles

public Collection<ResultHandle> getAllResultHandles()

Gets all ResultHandles that are defined in this scenario.

Returns:

a Collection of ResultHandles

submit

public void submit()
            throws at.srfg.miner.exception.MinerException

Submits the scenario to the MINER core.

Throws:

at.srfg.miner.exception.MinerException - If no connection to the webservice can be achieved or if the submit implementation at the MINER Core throws an exception.

schedule

public Execution schedule(Date start)
                   throws at.srfg.miner.exception.MinerException

Schedules the scenario for execution. Note that the scenario must have been successfully submitted before.

Parameters:

start - The date when the execution should start. The start date must not be null.

Returns:

an Execution instance

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(Date start,
                 String description)
                   throws at.srfg.miner.exception.MinerException

Schedules the scenario for execution. Note that the scenario must have been successfully submitted before.

Parameters:

start - The date when the execution should start. The start date must not be null.

description - A description of the execution

Returns:

an Execution instance

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(Date start,
                 Date stop)
                   throws at.srfg.miner.exception.MinerException

Schedules the scenario for execution. Note that the scenario must have been successfully submitted before.

Parameters:

start - The date when the execution should start. The start date must not be null.

stop - The date when the execution should stop. The stop date must be after the start date and it must be before now.

Returns:

an Execution instance

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(Date start,
                 Date stop,
                 String description)
                   throws at.srfg.miner.exception.MinerException

Schedules the scenario for execution. Note that the scenario must have been successfully submitted before.

Parameters:

start - The date when the execution should start. The start date must not be null.

stop - The date when the execution should stop. The stop date must be after the start date and it must be before now.

description - A description of the execution

Returns:

an Execution instance

Throws:

IllegalArgumentException - if start/stop times don't make sense

at.srfg.miner.exception.MinerException - if the scenario wasn't successfully submitted in a prior step

execute

public Execution execute()
                  throws at.srfg.miner.exception.MinerException

Executes the scenario immediately and without a defined stop time. The absolute start time is computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Returns:

An Execution instance

Throws:

at.srfg.miner.exception.MinerException - if the Scenario was not successfully submitted before.

execute

public Execution execute(String description)
                  throws at.srfg.miner.exception.MinerException

Executes the scenario immediately and without a defined stop time. The absolute start time is computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

description - The description of the execution

Returns:

An Execution instance

Throws:

at.srfg.miner.exception.MinerException - if the Scenario was not successfully submitted before.

execute

public Execution execute(int duration)
                  throws at.srfg.miner.exception.MinerException

Executes the scenario immediately for the given duration. The absolute start/stop times are computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

duration - The duration of the execution in [s].

Returns:

An Execution instance

Throws:

at.srfg.miner.exception.MinerException

execute

public Execution execute(int duration,
                String description)
                  throws at.srfg.miner.exception.MinerException

Executes the scenario immediately for the given duration. The absolute start/stop times are computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

duration - The duration of the execution in [s].

description - The description of the execution

Returns:

An Execution instance

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(int offset)
                   throws at.srfg.miner.exception.MinerException

Executes the scenario offset [s] in the future and and without a defined stop time. The absolute start time is computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

offset - The number of seconds that the execution is scheduled into the future.

Returns:

An Execution instance.

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(int offset,
                 String description)
                   throws at.srfg.miner.exception.MinerException

Executes the scenario offset [s] in the future and and without a defined stop time. The absolute start time is computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

offset - The number of seconds that the execution is scheduled into the future.

description - The description of the execution

Returns:

An Execution instance.

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(int offset,
                 int duration)
                   throws at.srfg.miner.exception.MinerException

Executes the scenario offset [s] in the future and for the given duration. The absolute start/stop times are computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

offset - The number of seconds that the execution is scheduled into the future.

duration - The duration of the execution in [s].

Returns:

An Execution instance.

Throws:

at.srfg.miner.exception.MinerException

schedule

public Execution schedule(int offset,
                 int duration,
                 String description)
                   throws at.srfg.miner.exception.MinerException

Executes the scenario offset [s] in the future and for the given duration. The absolute start/stop times are computed by the Server and thus this method is robust even if the client's clock is not synchronized with the Server. Note that the scenario must have been submitted before it can be run.

Parameters:

offset - The number of seconds that the execution is scheduled into the future.

duration - The duration of the execution in [s].

description - The description of the execution

Returns:

An Execution instance.

Throws:

at.srfg.miner.exception.MinerException

delete

public void delete()
            throws at.srfg.miner.exception.MinerException

Deletes the scenario, its executions incl. their results at the MINER Core.

Throws:

at.srfg.miner.exception.MinerException

getTaskByName

public Task getTaskByName(String taskName)

Searches for a task called taskName. Note that the search is done only over those tasks that are not included by reference!

Parameters:

taskName - the name of the task

Returns:

the first task found or null if none is found

getResultHandleByName

public ResultHandle getResultHandleByName(String resultName)

Searches the scenario for a ResultHandle called resultName.

Parameters:

resultName - the name of the ResultHandle

Returns:

the ResultHandle if exactly 1 ResultHandle called resultName exists or null if no such ResultHandle exists

Throws:

IllegalStateException - if the scenario contains more than 1 ResultHandle called resultName.

print

public boolean print()

Prints an XML representation of the scenario to System.out. If an exception occurs (e.g. in the transformation process from the scenario to a String), a logger warning is created and the return value is false.

Returns:

true if successful, false otherwise

print

public boolean print(java.io.OutputStream os)

Prints an XML representation of the scenario to the given Outputstream os. If an exception occurs (e.g. in the transformation process from the scenario to a String), a logger warning is created and the return value is false.

Parameters:

os - The destination output stream.

Returns:

true if successful, false otherwise

save

public boolean save(java.io.File file)

Saves an XML representation of the scenario to file. If an exception occurs (e.g. in the transformation process from the scenario to a String or when writing to the file), a logger warning and the return value is false.

Parameters:

file - the destination file

Returns:

true if successful, false otherwise

toXMLString

public String toXMLString()

Converts the scenario to a String containing an XML representation of the scenario. If an exception occurs (e.g. in the transformation process from the scenario to a String), a logger warning is created and the return value is null.

Returns:

the scenario as an XML String is successful, null otherwise.