ImportStatusFile

java.lang.Object
- java.io.File
- - com.highqsoft.importtool.ImportStatusFile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.io.File>
```
public class ImportStatusFile
extends java.io.File
```
Handling of Import Status File. The importtool reports the status of an import task in the import status file. This class implements reading and writing of this file. It also defines Fields with error numbers the application uses to signal errors during an import task to the sequencer.

Since:

$Date: 2017/04/06 13:29:19 $

Version:

$Revision: 4.17 $

Author:

Markus Schuldlos

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERR_FILE_NOT_FOUND` Numeric constant for status for "file not found"
`static int`	`ERR_MANUALLY_ABORTED` Numeric constant for manually aborted testruns (used by importtool monitor)
`static int`	`ERR_ODS_ERROR` Numeric constant for common ODS errors
`static int`	`ERR_SYNTAX_ERROR` Numeric constant for syntax error in il file
`static int`	`ERR_UNKNOWN_CONSTANT` Numeric constant for invalid testrun status
`static int`	`ERR_WRONG_NR_OF_ARGS` Numeric constant for wrong number of arguments in a command
`static int`	`INFO_UNKNOWN`
`static int`	`RELEASE` Constant for release information in is file header
`static int`	`SUCCESS` Numeric constant for status "success"
`static int`	`VERSION` Constant for version information in is file header
`static int`	`WARN_COPY_FILE_ERROR` Unable to copy file to result directory
`static int`	`WARN_CREATE_SESSION` Unable to create ODS session
`static int`	`WARN_FILE_NOT_FOUND` Numeric constant for "file not found" warnings.
`static int`	`WARN_INSTANCE_NOT_FOUND` Numeric constant for ODS instance not found
`static int`	`WARN_INTERNAL_ERROR` Uncaught Exception in Importtool
`static int`	`WARN_ODS_ERROR` Common ODS warning
`static int`	`WARN_READING_IL_FILE` Read error in il file
`static int`	`WARN_TOO_MANY_IL_FILES` More then one il File and no is file in import directory
`static int`	`WARN_WRITE_FILE_ERROR` Unable to write cache file

Fields inherited from class java.io.File
pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors
Constructor and Description

ImportStatusFile(java.lang.String pathName)
Create the ImportStatusFileObject.

Constructors
Constructor and Description
`ImportStatusFile(java.lang.String pathName)` Create the ImportStatusFileObject.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getErrorCode()` Get the error code from the import status file
`java.lang.String`	`getErrorText()` Get the error text from the import status file
`int`	`getExtensionNumber()` Get the last processed extension number from the Import Status File
`int`	`getLastSuccessfulLine()` Get the last successfully processed line from the Import Status File
`T_LONGLONG`	`getTestRunId()` Get the Id of the test from the Import Status File
`boolean`	`readFile()` Read the import status file and store the values in fields.
`void`	`setError(int code, java.lang.String text)` Set the errorCode
`void`	`setExtensionNumber(int nr)` Set the extension number.
`void`	`setLastSuccessfulLine(int line)` Set the last successfully processed line.
`void`	`setTestRunId(T_LONGLONG id)` Set the id of the testrun
`boolean`	`writeFile()` Write the import status file with the currently set values.

Methods inherited from class java.io.File
canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

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

- Field Detail
  - VERSION
```
public static final int VERSION
```
    Constant for version information in is file header
    
    See Also:
    Constant Field Values
  - RELEASE
```
public static final int RELEASE
```
    Constant for release information in is file header
    
    See Also:
    Constant Field Values
  - SUCCESS
```
public static final int SUCCESS
```
    Numeric constant for status "success"
    
    See Also:
    Constant Field Values
  - ERR_ODS_ERROR
```
public static final int ERR_ODS_ERROR
```
    Numeric constant for common ODS errors
    
    See Also:
    Constant Field Values
  - ERR_WRONG_NR_OF_ARGS
```
public static final int ERR_WRONG_NR_OF_ARGS
```
    Numeric constant for wrong number of arguments in a command
    
    See Also:
    Constant Field Values
  - ERR_FILE_NOT_FOUND
```
public static final int ERR_FILE_NOT_FOUND
```
    Numeric constant for status for "file not found"
    
    See Also:
    Constant Field Values
  - ERR_UNKNOWN_CONSTANT
```
public static final int ERR_UNKNOWN_CONSTANT
```
    Numeric constant for invalid testrun status
    
    See Also:
    Constant Field Values
  - ERR_SYNTAX_ERROR
```
public static final int ERR_SYNTAX_ERROR
```
    Numeric constant for syntax error in il file
    
    See Also:
    Constant Field Values
  - ERR_MANUALLY_ABORTED
```
public static final int ERR_MANUALLY_ABORTED
```
    Numeric constant for manually aborted testruns (used by importtool monitor)
    
    See Also:
    Constant Field Values
  - WARN_FILE_NOT_FOUND
```
public static final int WARN_FILE_NOT_FOUND
```
    Numeric constant for "file not found" warnings.
    
    See Also:
    Constant Field Values
  - WARN_INSTANCE_NOT_FOUND
```
public static final int WARN_INSTANCE_NOT_FOUND
```
    Numeric constant for ODS instance not found
    
    See Also:
    Constant Field Values
  - WARN_TOO_MANY_IL_FILES
```
public static final int WARN_TOO_MANY_IL_FILES
```
    More then one il File and no is file in import directory
    
    See Also:
    Constant Field Values
  - WARN_READING_IL_FILE
```
public static final int WARN_READING_IL_FILE
```
    Read error in il file
    
    See Also:
    Constant Field Values
  - WARN_WRITE_FILE_ERROR
```
public static final int WARN_WRITE_FILE_ERROR
```
    Unable to write cache file
    
    See Also:
    Constant Field Values
  - WARN_COPY_FILE_ERROR
```
public static final int WARN_COPY_FILE_ERROR
```
    Unable to copy file to result directory
    
    See Also:
    Constant Field Values
  - WARN_CREATE_SESSION
```
public static final int WARN_CREATE_SESSION
```
    Unable to create ODS session
    
    See Also:
    Constant Field Values
  - WARN_ODS_ERROR
```
public static final int WARN_ODS_ERROR
```
    Common ODS warning
    
    See Also:
    Constant Field Values
  - WARN_INTERNAL_ERROR
```
public static final int WARN_INTERNAL_ERROR
```
    Uncaught Exception in Importtool
    
    See Also:
    Constant Field Values
  - INFO_UNKNOWN
```
public static final int INFO_UNKNOWN
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ImportStatusFile
```
public ImportStatusFile(java.lang.String pathName)
```
    Create the ImportStatusFileObject.
    
    Parameters:
    pathName - absolute Pathname to import status file
- Method Detail
  - writeFile
```
public boolean writeFile()
```
    Write the import status file with the currently set values.
    
    Returns:
    created True if the file was written, false if there was an IOException.
  - readFile
```
public boolean readFile()
```
    Read the import status file and store the values in fields. If there is no file to read all fields are initialized with zero. This always happens at the first import command (create testrun).
    
    Returns:
    read True if the file was read, false if there was an IOException or a NumberFormatException. See Logfile for more details.
  - getTestRunId
```
public T_LONGLONG getTestRunId()
```
    Get the Id of the test from the Import Status File
    
    Returns:
    The Id of the Testrun.
  - getExtensionNumber
```
public int getExtensionNumber()
```
    Get the last processed extension number from the Import Status File
    
    Returns:
    Number of last processed il-file.
  - getLastSuccessfulLine
```
public int getLastSuccessfulLine()
```
    Get the last successfully processed line from the Import Status File
    
    Returns:
    The last successfully processed line in case of an error.
  - getErrorCode
```
public int getErrorCode()
```
    Get the error code from the import status file
    
    Returns:
    The numeric error code.
  - getErrorText
```
public java.lang.String getErrorText()
```
    Get the error text from the import status file
    
    Returns:
    The description of the error.
  - setTestRunId
```
public void setTestRunId(T_LONGLONG id)
```
    Set the id of the testrun
    
    Parameters:
    id - The testrun id.
  - setExtensionNumber
```
public void setExtensionNumber(int nr)
```
    Set the extension number.
    
    Parameters:
    nr - The extension number of the processed il-file.
  - setLastSuccessfulLine
```
public void setLastSuccessfulLine(int line)
```
    Set the last successfully processed line.
    
    Parameters:
    line - Number of last processed line.
  - setError
```
public void setError(int code,
            java.lang.String text)
```
    Set the errorCode
    
    Parameters:
    code - The error code.
    text - The error text.

Class ImportStatusFile

Field Summary

Fields inherited from class java.io.File

Constructor Summary

Method Summary

Methods inherited from class java.io.File

Methods inherited from class java.lang.Object

Field Detail

VERSION

RELEASE

SUCCESS

ERR_ODS_ERROR

ERR_WRONG_NR_OF_ARGS

ERR_FILE_NOT_FOUND

ERR_UNKNOWN_CONSTANT

ERR_SYNTAX_ERROR

ERR_MANUALLY_ABORTED

WARN_FILE_NOT_FOUND

WARN_INSTANCE_NOT_FOUND

WARN_TOO_MANY_IL_FILES

WARN_READING_IL_FILE

WARN_WRITE_FILE_ERROR

WARN_COPY_FILE_ERROR

WARN_CREATE_SESSION

WARN_ODS_ERROR

WARN_INTERNAL_ERROR

INFO_UNKNOWN

Constructor Detail

ImportStatusFile

Method Detail

writeFile

readFile

getTestRunId

getExtensionNumber

getLastSuccessfulLine

getErrorCode

getErrorText

setTestRunId

setExtensionNumber

setLastSuccessfulLine

setError