com.highqsoft.mdf

Class MDFHeader

java.lang.Object

com.highqsoft.mdf.MDFHeader

public class MDFHeader
extends java.lang.Object

This is MDF header created by the MDFHeaderFactory.
The MDF specification allows a comment field at the beginning of the file. This comment is sometimes used to define name value pairs. These definitions are the fields of the MDF file. Using the method getFieldMap() is is possible to retrieve a map containing the field definitions.
The beginning of a field definition identified by the pattern \s*\$FIELD\s*:\s*"
The separation part is identified by the pattern "\s*[,:;]\s*"
The end is identified by the pattern .*"\s*\$\s*

An example of this type of header:

$FIELD: "ProjectGroup","CCP"$
$FIELD: "Comment",""$
$FIELD: "Vehicle","212-881"$
$FIELD: "Carer",""$
$FIELD: "EngineType","Benzin"$
 

Another variant is also allowed and uses a tab-character to separate the keyword from value. There is not identifier like $Field that help to find a definition.

An example of this type of header:

Stop date   16.02.2010
Stop time   18:44:57
TriggerName 
MeasurementKey ZEIT
ActivityName   Signals
SerialNumber   80001552
 

The field map will enriched by some useful attributes listed below.

Key	Description
Header.Filename	The name of the file defined by the MDF header.
Header.Date	The date string defined by the MDF header.
Header.Department	The name of the department defined by the MDF header.
Header.Project	The name of the project defined by the MDF header.
Header.Time	The time string defined by the MDF header.
Header.UnitUnderTest	The name of the unit under test defined in MDF header.
Header.User	The user name defined in MDF header.

Some fields will be generated from filename, if not defined in header comment. The filename will be split at a tilde (~), if the index of the result array starts by zero, the following values will be generated, if not already available and the array length if greater than 4.

Key	Array Index	Description
ConfigName	1 (second)	The configuration name
MeasurementKey	length-2 (next to last)	The measurement key.
TriggerName	length-1 (last)	The name of the activity
ActivityName	length-1 (last)	The name of the activity

Some fields will be generated, if not available, by an existing field called TSTDRIVE. For this reason the value will be split at tab character. The elements of the result array will be assigned to following field attributes, if these attributes are not already defined.

Key	Array Index	Description
RecorderFirmware	0 (first)	The firmware version of the recorder.
MeasurementFileName	length-1 (last)	The name of the originial measurement file.

Since:

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

Version:

$Revision: 1.21 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MDFHeader.FieldSplitter The interface that an field splitter must fulfill.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT_TYPE_KEY
static java.lang.String	ECU_SEP
static java.lang.String	ECU_TYPE
protected java.lang.String	errorMessage
protected int	exitCode
protected MDFField[]	fields
static java.lang.String	FILENAME_ATTR
static java.lang.String	HD_NODE
static java.lang.String	ID_NODE
protected MdfHeader	mdfHeader
static java.lang.String	TABBED_COMMENT

Constructor Summary

Constructors

Constructor and Description
MDFHeader()
MDFHeader(MdfHeader mdfHeader) The default constructor.
MDFHeader(MdfHeader mdfHeader, int exitCode, java.lang.String errorMessage) The default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	extendFields(java.io.InputStream stream, MDFHeader.FieldSplitter splitter) Extends the fields of header.
void	extendFields(MDFField[] fieldArr) Extends the fields of header.
void	extendFields(java.lang.String filename) Extends the fields of header.
void	extendFields(java.lang.String filename, MDFHeader.FieldSplitter splitter) Extends the fields of header.
java.util.Map<java.lang.String,java.lang.String>	getFieldMap() Get a map containing the fields.
MdfHeader	getHeader() Get the header of the document.
java.lang.String	getReaderErrorMessage() Get the error message of the reader process.
int	getReaderExitCode() Get the exit code of the reader process.
static MDFField[]	readFieldsFromFile(java.lang.String filename) Read the fields from header file.
protected void	readFieldsFromHeader() Read the fields from header.
static MDFField[]	readFieldsFromHeaderStream(java.io.InputStream stream) Read the fields from header.
static MDFField[]	readFieldsFromTabbedHeaderStream(java.io.InputStream stream) Reads the fields from a header without correct format.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMENT_TYPE_KEY

public static final java.lang.String COMMENT_TYPE_KEY

See Also:

Constant Field Values

TABBED_COMMENT

public static final java.lang.String TABBED_COMMENT

See Also:

Constant Field Values

ECU_TYPE

public static final java.lang.String ECU_TYPE

See Also:

Constant Field Values

ECU_SEP

public static final java.lang.String ECU_SEP

See Also:

Constant Field Values

FILENAME_ATTR

public static final java.lang.String FILENAME_ATTR

See Also:

Constant Field Values

ID_NODE

public static final java.lang.String ID_NODE

See Also:

Constant Field Values

HD_NODE

public static final java.lang.String HD_NODE

See Also:

Constant Field Values

mdfHeader

protected MdfHeader mdfHeader

fields

protected MDFField[] fields

exitCode

protected int exitCode

errorMessage

protected java.lang.String errorMessage

Constructor Detail

MDFHeader

public MDFHeader()

MDFHeader

public MDFHeader(MdfHeader mdfHeader)
          throws java.io.IOException

The default constructor.

Parameters:

mdfHeader - coming from XML schema.

Throws:

java.io.IOException

MDFHeader

public MDFHeader(MdfHeader mdfHeader,
         int exitCode,
         java.lang.String errorMessage)
          throws java.io.IOException

The default constructor.

Parameters:

mdfHeader - coming from XML schema.

exitCode - the exit code of the reader process.

errorMEssage - the error message of the reader process.

Throws:

java.io.IOException

Method Detail

readFieldsFromHeader

protected void readFieldsFromHeader()
                             throws java.io.IOException

Read the fields from header.

Throws:

java.io.IOException

readFieldsFromFile

public static MDFField[] readFieldsFromFile(java.lang.String filename)
                                     throws java.io.FileNotFoundException,
                                            java.io.IOException

Read the fields from header file.

Throws:

java.io.FileNotFoundException

java.io.IOException

readFieldsFromHeaderStream

public static MDFField[] readFieldsFromHeaderStream(java.io.InputStream stream)
                                             throws java.io.IOException

Read the fields from header.

Throws:

java.io.IOException

readFieldsFromTabbedHeaderStream

public static MDFField[] readFieldsFromTabbedHeaderStream(java.io.InputStream stream)
                                                   throws java.io.IOException

Reads the fields from a header without correct format.

Parameters:

stream - the stream which contains the data

Returns:

an Array of MDFField

Throws:

java.io.IOException

getFieldMap

public java.util.Map<java.lang.String,java.lang.String> getFieldMap()

Get a map containing the fields. This presumes that the field names are unique.

Returns:

A map containing the name value pairs of the fields.

getReaderExitCode

public int getReaderExitCode()

Get the exit code of the reader process.

Returns:

the exit code.

getReaderErrorMessage

public java.lang.String getReaderErrorMessage()

Get the error message of the reader process.

Returns:

the error message.

getHeader

public MdfHeader getHeader()

Get the header of the document.

Returns:

the header element.

extendFields

public void extendFields(java.lang.String filename)
                  throws java.io.FileNotFoundException,
                         java.io.IOException

Extends the fields of header.

Parameters:

filename - the filename from which the fields should be read.

Throws:

java.io.FileNotFoundException

java.io.IOException

extendFields

public void extendFields(java.lang.String filename,
                MDFHeader.FieldSplitter splitter)
                  throws java.io.FileNotFoundException,
                         java.io.IOException

Extends the fields of header.

Parameters:

filename - the filename from which the fields should be read.

splitter - the filed splitter.

Throws:

java.io.FileNotFoundException

java.io.IOException

extendFields

public void extendFields(java.io.InputStream stream,
                MDFHeader.FieldSplitter splitter)
                  throws java.io.FileNotFoundException,
                         java.io.IOException

Extends the fields of header.

Parameters:

filename - the filename from which the fields should be read.

splitter - the filed splitter.

Throws:

java.io.FileNotFoundException

java.io.IOException

extendFields

public void extendFields(MDFField[] fieldArr)

Extends the fields of header.

Parameters:

filename - the filename from which the fields should be read.

splitter - the filed splitter.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object