com.tplan.robot.scheduler

Class Schedule

java.lang.Object

javax.swing.table.AbstractTableModel

javax.swing.table.DefaultTableModel

com.tplan.robot.scheduler.Schedule

All Implemented Interfaces:

RefactoringCapable, RepeatingScriptedExecutable, ScriptedExecutable, GenericListener<ScheduleListener>, Serializable, TableModel

public class Schedule
extends DefaultTableModel
implements GenericListener<ScheduleListener>, RepeatingScriptedExecutable, RefactoringCapable

Schedule encapsulates a TestSuite and provides framework for I/O operations, execution and displaying in the GUI.

See Also:

Serialized Form

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEDULER_HOME_DIR_NAME
static String	SCHEDULER_REPORT_DIR_SUFFIX

Fields inherited from interface com.tplan.robot.scripting.RepeatingScriptedExecutable

EVENT_REPEATED_EXECUTION_COMPLETED

Constructor Summary

Constructors

Constructor and Description
Schedule()
Schedule(String name)

Method Summary

Modifier and Type	Method and Description
static void	addGlobalScheduleListener(ScheduleListener l)
void	addScheduleListener(ScheduleListener l)
void	execute() Execute the schedule.
void	genericEvent(ScheduleListener listener, EventObject event, Object customObject) Call the listener method on a particular listener.
int	getBranchCount() Find out how many branches the schedule contains.
int	getColumnCount() Implementation of TableModel.getColumnCount() allowing to use the schedule directly with JTable.
Integer	getCommandNo()
static File	getDefaultScheduleDir() Get the default directory to store the schedule to.
long	getEndTime()
Thread	getExecThread() Get the execution thread.The method returns null if the schedule is not executing.
int	getExecutionCount() Get the number of requested executions.
Integer	getExecutionSeqNo() Get the executor sequence number.
int	getExitCode() Get the schedule exit code to be returned to the underlying OS.
File	getFile() Get the file this schedule is stored to.
List<RefactoringTask>	getFileMoveOrCopyRefactoringTasks(Map<File,File> changes) Get the list of refactoring tasks for the argument map of file updates.
long	getLastChanged()
PrintStream	getLogStream() Get the log stream.
int	getRowCount() Implementation of TableModel.getRowCount() allowing to use the schedule directly with JTable.
ScriptManager	getScriptManager() Get the script manager.
long	getStartTime()
List<File>	getTemporaryFiles(File scriptFile) Get the temporary files created by the script.
TestSuite	getTestSuite() Get the test suite (the sequence of tasks and their dependencies).
String	getUid()
Object	getValueAt(int rowIndex, int columnIndex) Implementation of TableModel.getValueAt(int, int) allowing to use the schedule directly with JTable.
boolean	isAskForMandatoryInputParametersOnly() Indicates whether the workitem is configured to pop up the input parameter prompt always (false) or only when at least one mandatory parameter is not populated.
boolean	isCellEditable(int rowIndex, int columnIndex) Implementation of TableModel.isCellEditable(int, int) allowing to use the schedule directly with JTable.
boolean	isChanged()
boolean	isExecuting() Find out if the schedule is executing or not.
boolean	isExecutingOrFinishing() Test whether it is safe to exit, i.e.
boolean	isPause() Find out if the executable is executing and paused.
boolean	isSchedule() Indicate whether this object is a workitem or a schedule (i.e.
boolean	isStop() Find out if the executable was stopped.
void	read(File descriptor)
void	read(InputStream stream)
void	read(String content) Read the schedule from a string.
void	refactoringCompleted() Called after the refactoring of the tasks returned by the implementing object gets successfully completed.
static Object	removeGlobalScheduleListener(ScheduleListener l)
Object	removeScheduleListener(ScheduleListener l)
void	saveAs(File target) Save the schedule to an XML file.
void	saveAs(File target, boolean resetUid)
void	setAskForMandatoryInputParametersOnly(boolean askMandatoryOnly) Configure the workitem to pop up the input parameter prompt always (false) or only when at least one mandatory parameter is not populated.
void	setCommandNo(Integer commandNo)
void	setExecutionCount(Integer count) Set the number of requested executions.
void	setFile(File f) Set the target schedule file.
void	setLogStream(PrintStream logStream) Set the log stream.
void	setPause(Object source, boolean pause, String reason) Request to pause the executing object.
void	setScriptManager(ScriptManager scriptManager) Set the script manager.
void	setStop(Object source, boolean stop, boolean isManual, String manualStopJustification) Request to stop the executing object.
String	toString(boolean indented) Export the schedule to an XML string.
static String	toString(Document doc)
static String	toString(Document doc, boolean indent)
Document	toXML()

Methods inherited from class javax.swing.table.DefaultTableModel

addColumn, addColumn, addColumn, addRow, addRow, getColumnName, getDataVector, insertRow, insertRow, moveRow, newDataAvailable, newRowsAdded, removeRow, rowsRemoved, setColumnCount, setColumnIdentifiers, setColumnIdentifiers, setDataVector, setDataVector, setNumRows, setRowCount, setValueAt

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getColumnClass, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Field Detail

SCHEDULER_HOME_DIR_NAME

public static final String SCHEDULER_HOME_DIR_NAME

See Also:

Constant Field Values

SCHEDULER_REPORT_DIR_SUFFIX

public static final String SCHEDULER_REPORT_DIR_SUFFIX

See Also:

Constant Field Values

Constructor Detail

Schedule

public Schedule()

Schedule

public Schedule(String name)

Method Detail

read

public void read(File descriptor)
          throws ParserConfigurationException,
                 SAXException,
                 IOException

Throws:

ParserConfigurationException

SAXException

IOException

read

public void read(InputStream stream)
          throws ParserConfigurationException,
                 SAXException,
                 IOException

Throws:

ParserConfigurationException

SAXException

IOException

read

public void read(String content)
          throws ParserConfigurationException,
                 SAXException,
                 IOException

Read the schedule from a string.

Parameters:

content - the schedule XML descriptor.

Throws:

ParserConfigurationException - on parser configuration error.

SAXException - on SAX error.

IOException - on I/O error.

Since:

4.2.1

toString

public static String toString(Document doc)
                       throws IOException

Throws:

IOException

toString

public static String toString(Document doc,
                              boolean indent)
                       throws IOException

Throws:

IOException

toXML

public Document toXML()

toString

public String toString(boolean indented)
                throws IOException

Export the schedule to an XML string.

Parameters:

indented - true to indent the code to make it human readable.

Returns:

the XML code as a String.

Throws:

IOException - on an I/O error.

Since:

4.2.1

getTestSuite

public TestSuite getTestSuite()

Get the test suite (the sequence of tasks and their dependencies).

Returns:

the test suite.

getBranchCount

public int getBranchCount()

Find out how many branches the schedule contains. It is equivalent to the maximum number of parallel processes needed to execute the schedule.

Returns:

number of branches (rows).

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Implementation of TableModel.isCellEditable(int, int) allowing to use the schedule directly with JTable.

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class DefaultTableModel

Parameters:

rowIndex - row index.

columnIndex - column index.

Returns:

this implementation always returns false.

getRowCount

public int getRowCount()

Implementation of TableModel.getRowCount() allowing to use the schedule directly with JTable.

Specified by:

getRowCount in interface TableModel

Overrides:

getRowCount in class DefaultTableModel

Returns:

number of rows.

getColumnCount

public int getColumnCount()

Implementation of TableModel.getColumnCount() allowing to use the schedule directly with JTable.

Specified by:

getColumnCount in interface TableModel

Overrides:

getColumnCount in class DefaultTableModel

Returns:

number of columns.

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Implementation of TableModel.getValueAt(int, int) allowing to use the schedule directly with JTable.

Specified by:

getValueAt in interface TableModel

Overrides:

getValueAt in class DefaultTableModel

Parameters:

rowIndex - row index.

columnIndex - column index.

Returns:

value at the given row and column. In this implementation it may be one of null, TestSuite or Task.

getFile

public File getFile()

Get the file this schedule is stored to. It is the file passed through the last call of the read(java.io.File), saveAs(java.io.File) of setFile(java.io.File) method. If none of the methods has been called the method returns null.

Returns:

the file

getDefaultScheduleDir

public static File getDefaultScheduleDir()

Get the default directory to store the schedule to. If a project is open the method returns the schedules/ folder in the project home folder. If no project is open the method returns the <USER_HOME>/schedules folder. As there's no guarantee that the returned location exists the class that wants to save the schedule to it must call File.mkdirs() to ensure it gets created.

Returns:

the default schedule location.

saveAs

public void saveAs(File target)
            throws IOException

Save the schedule to an XML file.

Parameters:

target - the target file. If it is relative it will be resolved against the default schedule home directory returned by getDefaultScheduleDir().

Throws:

IOException - on an I/O error.

saveAs

public void saveAs(File target,
                   boolean resetUid)
            throws IOException

Throws:

IOException

setFile

public void setFile(File f)

Set the target schedule file. The method only sets the file property but it doesn't save the schedule to the file. To save the schedule call saveAs(java.io.File).

Parameters:

f - a new file.

setExecutionCount

public void setExecutionCount(Integer count)

Description copied from interface: RepeatingScriptedExecutable

Set the number of requested executions.

Specified by:

setExecutionCount in interface RepeatingScriptedExecutable

Parameters:

count - the number of executions.

getExecutionCount

public int getExecutionCount()

Description copied from interface: RepeatingScriptedExecutable

Get the number of requested executions.

Specified by:

getExecutionCount in interface RepeatingScriptedExecutable

Returns:

the number of scheduled executions.

execute

public void execute()

Execute the schedule.

Throws:

IllegalStateException - if the schedule is already executing or cleaning up after execution. To test whether it's safe to execute the schedule use the isExecutingOrFinishing() method.

getExecThread

public Thread getExecThread()

Get the execution thread.The method returns null if the schedule is not executing.

Returns:

the execution thread.

Since:

4.0.1

isExecuting

public boolean isExecuting()

Find out if the schedule is executing or not.

Specified by:

isExecuting in interface ScriptedExecutable

Returns:

true if the schedule is executing or false if not.

isExecutingOrFinishing

public boolean isExecutingOrFinishing()

Test whether it is safe to exit, i.e. whether the schedule is not executing or not performing cleanup (message dispatching) that immediately follows the execution.

Returns:

true if it's safe to exit.

getExecutionSeqNo

public Integer getExecutionSeqNo()

Get the executor sequence number.

Returns:

the unique sequence number.

Since:

4.2.1

isStop

public boolean isStop()

Description copied from interface: ScriptedExecutable

Find out if the executable was stopped.

Specified by:

isStop in interface ScriptedExecutable

Returns:

true if the executable was stopped.

setStop

public void setStop(Object source,
                    boolean stop,
                    boolean isManual,
                    String manualStopJustification)

Description copied from interface: ScriptedExecutable

Request to stop the executing object.

Specified by:

setStop in interface ScriptedExecutable

Parameters:

source - source of the request (for tracking purposes).

stop - true to request stop, false to reset the stop flag.

isManual - true if the stop is manual/user requested (for tracking purposes).

manualStopJustification - optional stop justification.

setPause

public void setPause(Object source,
                     boolean pause,
                     String reason)

Description copied from interface: ScriptedExecutable

Request to pause the executing object.

Specified by:

setPause in interface ScriptedExecutable

Parameters:

source - source of the request (for tracking purposes).

pause - true to request pause, false to reset the pause flag.

reason - optional pause justification.

isPause

public boolean isPause()

Description copied from interface: ScriptedExecutable

Find out if the executable is executing and paused.

Specified by:

isPause in interface ScriptedExecutable

Returns:

true if the executable is paused.

addScheduleListener

public void addScheduleListener(ScheduleListener l)

removeScheduleListener

public Object removeScheduleListener(ScheduleListener l)

addGlobalScheduleListener

public static void addGlobalScheduleListener(ScheduleListener l)

removeGlobalScheduleListener

public static Object removeGlobalScheduleListener(ScheduleListener l)

genericEvent

public void genericEvent(ScheduleListener listener,
                         EventObject event,
                         Object customObject)

Description copied from interface: GenericListener

Call the listener method on a particular listener. For example, when the listener is a ChangeListener the method should call listener.stateChanged((ChangeEvent)event). This method will be called by the GenericListenerSupport.fireEvent(com.tplan.robot.util.GenericListener, java.util.EventObject, java.lang.Object) method for each registered listener.

Specified by:

genericEvent in interface GenericListener<ScheduleListener>

Parameters:

listener - the registered listener.

event - an event to fire to the listener. The implementing class should check whether it is an appropriate event matching the listener type and throw an IllegalArgumentException if not. For example, if the listener is a ChangeListener the event must be a ChangeEvent.

customObject - an optional object allowing the implementing class to transfer data between individual call of this method. For example, the argument may be a List where the method will store all exceptions thrown by the listener to.

isChanged

public boolean isChanged()

Returns:

the changed

getStartTime

public long getStartTime()

getEndTime

public long getEndTime()

getScriptManager

public ScriptManager getScriptManager()

Get the script manager. If the product is running in the GUI mode the method returns the shared script manager instance obtained through the MainFrame.getScriptHandler() method. For CLI mode the calling AutomatedRunnable must set the script manager through setScriptManager(com.tplan.robot.scripting.ScriptManager) prior to executing the schedule.

Returns:

the script manager.

setScriptManager

public void setScriptManager(ScriptManager scriptManager)

Set the script manager.

Parameters:

scriptManager - the script manager instance to be used for schedule execution.

getLogStream

public PrintStream getLogStream()

Get the log stream. It is used during CLI mode to print the logs to.

Returns:

the CLI execution log stream.

setLogStream

public void setLogStream(PrintStream logStream)

Set the log stream. It is used during CLI mode to print the logs to.

Parameters:

logStream - the CLI execution log stream.

getFileMoveOrCopyRefactoringTasks

public List<RefactoringTask> getFileMoveOrCopyRefactoringTasks(Map<File,File> changes)

Description copied from interface: RefactoringCapable

Get the list of refactoring tasks for the argument map of file updates.

Specified by:

getFileMoveOrCopyRefactoringTasks in interface RefactoringCapable

Parameters:

changes - a map of [newFile, oldFile] pairs identifying the files that were moved or copied.

Returns:

the list of atomic refactoring tasks. One such a task typically represents update of a resource reference in a single location of the script.

getTemporaryFiles

public List<File> getTemporaryFiles(File scriptFile)

Description copied from interface: RefactoringCapable

Get the temporary files created by the script. For example, a Java test script may have one or more .class files in the classes/ folder. A TPR script may also produce .class files resulting from a compilation of a Java code block.

The method should work even if the script source code hasn't been loaded yet. Rather than caching the list of created files and returning it the method should query the local file system and search the usual locations for files that meet a certain pattern. For example, a Java test script may expect that the /classes folder will contain the compiled code as one or more .class files of known name or name pattern.

Specified by:

getTemporaryFiles in interface RefactoringCapable

Parameters:

scriptFile - optional script file to be used when the test script interpret hasn't been associated with a file (URI) yet. If the argument is null the interpret must default to the file returned by TestScriptInterpret.getURI().

Returns:

the list of temporary files, typically for deletion purposes.

refactoringCompleted

public void refactoringCompleted()

Description copied from interface: RefactoringCapable

Called after the refactoring of the tasks returned by the implementing object gets successfully completed.

Specified by:

refactoringCompleted in interface RefactoringCapable

getUid

public String getUid()

Returns:

the uid

getLastChanged

public long getLastChanged()

Returns:

the lastChanged

getCommandNo

public Integer getCommandNo()

Returns:

the commandNo

setCommandNo

public void setCommandNo(Integer commandNo)

Parameters:

commandNo - the commandNo to set

getExitCode

public int getExitCode()

Get the schedule exit code to be returned to the underlying OS.

• Version 4.4.2 and lower returns the value of 0 (PASS) unless the schedule gets stopped or crashes.
• Version 4.4.3 and newer returns 0 if the schedule completes (no stop or crash) and if all tasks return the PASS result too. Otherwise it returns the exit code of the first failed task.

Returns:

the overall numeric result of the schedule execution where the value of 0 means PASS (no issues detected) and any other value is FAIL.

Since:

4.4.3

isSchedule

public boolean isSchedule()

Indicate whether this object is a workitem or a schedule (i.e. a workitem with scheduling instructions).

Returns:

true for schedule or false for a workitem

isAskForMandatoryInputParametersOnly

public boolean isAskForMandatoryInputParametersOnly()

Indicates whether the workitem is configured to pop up the input parameter prompt always (false) or only when at least one mandatory parameter is not populated.

Returns:

false/true to display the input parameter prompt always/on missing mandatory params only.

Since:

6.3

setAskForMandatoryInputParametersOnly

public void setAskForMandatoryInputParametersOnly(boolean askMandatoryOnly)

Configure the workitem to pop up the input parameter prompt always (false) or only when at least one mandatory parameter is not populated.

Parameters:

askMandatoryOnly - false/true to display the input parameter prompt always/on missing mandatory params only.

Since:

6.3