AbstractTestTable (SAFS API DOCUMENT)

java.lang.Object
- org.safs.model.AbstractTestRecord
- - org.safs.model.AbstractTestTable

All Implemented Interfaces:

TestRecordParametersInterface

Direct Known Subclasses:

CycleTestTable, StepTestTable, SuiteTestTable
```
public abstract class AbstractTestTable
extends AbstractTestRecord
```
The intended superclass for all Test Table classes. This abstract class contains most of the workhorse code for building and exporting test tables. The specific subclasses finish up the implementation for each different type of test table (Cycle, Suite, and Step).

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List`	`_commands`
`static java.lang.String`	`CYCLE_TABLE_FILE_EXTENSION` 'CDD'
`static java.lang.String`	`DEFAULT_FIELD_SEPARATOR`
`static java.lang.String`	`STEP_TABLE_FILE_EXTENSION` 'SDD'
`static java.lang.String`	`SUITE_TABLE_FILE_EXTENSION` 'STD'

Fields inherited from class org.safs.model.AbstractTestRecord
_parameters, BLOCKID_RECORD_TYPE, BREAKPOINT_RECORD_TYPE, COMPONENT_FUNCTION_FAILOK_RECORD_TYPE, COMPONENT_FUNCTION_RECORD_TYPE, COMPONENT_FUNCTION_WARNOK_RECORD_TYPE, DRIVER_COMMAND_FAILOK_RECORD_TYPE, DRIVER_COMMAND_RECORD_TYPE, DRIVER_COMMAND_WARNOK_RECORD_TYPE, EMPTY_PARAMETER, ENGINE_COMMAND_FAILOK_RECORD_TYPE, ENGINE_COMMAND_RECORD_TYPE, ENGINE_COMMAND_WARNOK_RECORD_TYPE, PROJECT_COMMAND_RECORD_TYPE, SKIPPED_RECORD_TYPE

Constructor Summary

Constructors
Constructor and Description
`AbstractTestTable(java.lang.String testTableName, java.lang.String testTableFileExtension)` Create a new instance of a test table with the provided name and export file extension.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Command command)` Append the provided command\record to our table's store of test records.
`java.lang.String`	`exportTestRecord(java.lang.String fieldSeparator)` Exports the one record used to call the test table including the ending newline.
`void`	`exportToCSV(java.lang.String filePath)` Export the table to a field-delimited file in the specified filePath directory.
`java.util.List`	`getCommands()` Retrieve an unmodifiable List of this table's test record objects
`protected java.lang.String`	`getSAFSFileName()` Returns the concatenation of the table name, period, and table extension.
`java.lang.String`	`getTestRecordFieldSeparator()` Retrieve the single separator String character for this table.
`java.lang.String`	`getTestTableFileExtension()` Return the current file extension setting used during exports for this table.
`java.lang.String`	`getTestTableName()` Return the name of this test table.
`boolean`	`isExported()` Returns true if the table has already been exported.
`void`	`setTestRecordFieldSeparator(java.lang.String separator)` Specify an alternate single separator String (other than TAB) to be used to delimit the fields in the records of this table.
`void`	`setTestTableFileExtension(java.lang.String testTableExtension)` Set the file extension to be used when exporting this test table.
`protected void`	`validateCommand(Command command)` Throw an IllegalArgumentException if the command is not valid.

Methods inherited from class org.safs.model.AbstractTestRecord
addParameter, addParameters, appendParametersToTestRecord, getParameters

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_FIELD_SEPARATOR
```
public static final java.lang.String DEFAULT_FIELD_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - STEP_TABLE_FILE_EXTENSION
```
public static final java.lang.String STEP_TABLE_FILE_EXTENSION
```
    'SDD'
    
    See Also:
    
    Constant Field Values
  - SUITE_TABLE_FILE_EXTENSION
```
public static final java.lang.String SUITE_TABLE_FILE_EXTENSION
```
    'STD'
    
    See Also:
    
    Constant Field Values
  - CYCLE_TABLE_FILE_EXTENSION
```
public static final java.lang.String CYCLE_TABLE_FILE_EXTENSION
```
    'CDD'
    
    See Also:
    
    Constant Field Values
  - _commands
```
protected java.util.List _commands
```
- Constructor Detail
  - AbstractTestTable
```
public AbstractTestTable(java.lang.String testTableName,
                         java.lang.String testTableFileExtension)
```
    Create a new instance of a test table with the provided name and export file extension. The name cannot be null or zero-length, but the file extension can be.
    
    Parameters:
    
    testTableName - -- the name cannot be null or zero-length
    
    testTableFileExtension -
    
    Throws:
    
    java.lang.IllegalArgumentException - if testTableName is null or zero-length
- Method Detail
  - getTestTableName
```
public final java.lang.String getTestTableName()
```
    Return the name of this test table. The name does NOT include the file extension.
    
    Returns:
    
    the name of this test table
  - getTestTableFileExtension
```
public final java.lang.String getTestTableFileExtension()
```
    Return the current file extension setting used during exports for this table.
    
    Returns:
    
    current testTableExtension setting. Can be null or zero-length.
  - setTestTableFileExtension
```
public final void setTestTableFileExtension(java.lang.String testTableExtension)
```
    Set the file extension to be used when exporting this test table. This value can be null or zero-length in which case no file extension will be used.
    
    Parameters:
    
    testTableExtension - -- the file extension to use for this table. Might be null or zero-length.
  - getTestRecordFieldSeparator
```
public final java.lang.String getTestRecordFieldSeparator()
```
    Retrieve the single separator String character for this table.
    
    Returns:
    
    the single separator String that will delimit test record fields.
  - setTestRecordFieldSeparator
```
public final void setTestRecordFieldSeparator(java.lang.String separator)
```
    Specify an alternate single separator String (other than TAB) to be used to delimit the fields in the records of this table. If using the default TAB character than this function does not need to be called.
    
    Parameters:
    
    separator - -- String character used to delimite test record fields
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided separator is null or zero-length.
  - getCommands
```
public final java.util.List getCommands()
```
    Retrieve an unmodifiable List of this table's test record objects
    
    Returns:
    
    unmodifiableList
  - add
```
public final void add(Command command)
```
    Append the provided command\record to our table's store of test records. Note that ComponentFunction commands do not subclass Command because they are only valid at the StepTestTable level. All other command types should be acceptable though. They will be validated with validateCommand.
    
    Parameters:
    
    command -
    
    Throws:
    
    java.lang.IllegalArgumentException - if command is null or if validateCommand throws the exception.
  - isExported
```
public final boolean isExported()
```
    Returns true if the table has already been exported.
    
    Returns:
    
    true if the table has already been exported.
  - validateCommand
```
protected void validateCommand(Command command)
```
    Throw an IllegalArgumentException if the command is not valid.
    Example: CallStep is not valid in Cycle and Suite tables.
    Subclasses should override this method to check whether the specified command is valid for its test table type. If the command is not valid, an IllegalArgumentException with a detailed message should be thrown. Valid commands simply do not throw the exception.
    
    Parameters:
    
    command - -- the command to validate
    
    Throws:
    
    java.lang.IllegalArgumentException - if the command is not valid for the current test table type
  - getSAFSFileName
```
protected java.lang.String getSAFSFileName()
```
    Returns the concatenation of the table name, period, and table extension. If the current file extension is null or zero-length then we only return the test table name.
    
    Returns:
    
    'filename.ext', or just 'filename' if no extension is set
  - exportTestRecord
```
public java.lang.String exportTestRecord(java.lang.String fieldSeparator)
```
    Exports the one record used to call the test table including the ending newline. Remember, while a test table may have multiple records of its own, the calling test table invokes it with a Project Command test record like below:
    A test table must export this test record when it is asked to do so.
    Parameters:
    
    fieldSeparator - used to delimit fields in test record
    
    Returns:
    
    String -- newline-terminated test record ready for export
  - exportToCSV
```
public void exportToCSV(java.lang.String filePath)
```
    Export the table to a field-delimited file in the specified filePath directory. This not only exports this one table, but also exports any tables called by this table. Those other called tables will also export any tables they call, and so on. So, for most cases, calling this routine on the topmost table will export all tables needed for the test.
    
    Parameters:
    
    filePath - -- the full path to the directory in which the table should be exported.

Class AbstractTestTable

Field Summary

Fields inherited from class org.safs.model.AbstractTestRecord

Constructor Summary

Method Summary

Methods inherited from class org.safs.model.AbstractTestRecord

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FIELD_SEPARATOR

STEP_TABLE_FILE_EXTENSION

SUITE_TABLE_FILE_EXTENSION

CYCLE_TABLE_FILE_EXTENSION

_commands

Constructor Detail

AbstractTestTable

Method Detail

getTestTableName

getTestTableFileExtension

setTestTableFileExtension

getTestRecordFieldSeparator

setTestRecordFieldSeparator

getCommands

add

isExported

validateCommand

getSAFSFileName

exportTestRecord

exportToCSV