com.highqsoft.util.ubh

Class UBH

java.lang.Object

javax.swing.filechooser.FileFilter

com.highqsoft.fwk.FwkFileFilter

com.highqsoft.util.ubh.UBH

All Implemented Interfaces:

FwkComponentInterface, FwkFileFilterInterface, FwkInterface, FwkReadColumnsFromStreamInterface, UBHInterface, java.io.Serializable

public class UBH
extends FwkFileFilter
implements UBHInterface, FwkReadColumnsFromStreamInterface

The UBH (Universal Binary Header).

Property Keyword	Datatype	Default	Description
UBH.Text.Description	classname	(*.ub)	File type description.

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BinaryFormat	binaryFormat
protected int	blockCount
protected int	blocking
static java.lang.String	C_DATATYPE_UNKNOWN
static java.lang.String	C_DATATYPENAME
static java.lang.String[]	C_DATATYPES
protected FwkColumnAccessInterface[]	columns
static java.lang.String	COMMENT
protected java.lang.String	dataFile
static java.lang.String	DATATYPE
static int	DT_CHAR
static int	DT_DOUBLE
static int	DT_FLOAT
static int	DT_INT
static int	DT_LONG
static int	DT_SHORT
static int	DT_UCHAR
static int	DT_UINT
static int	DT_ULONG
static int	DT_USHORT
protected java.lang.String	name
protected java.lang.String	path
protected FwkPropertyGroupInterface	propertyGroup
protected int	sectionSize
protected int	signalCount
protected long[]	signalOffset
protected SignalInterface[]	signals
protected java.lang.String	ubhFile

Fields inherited from class com.highqsoft.fwk.FwkFileFilter

version

Constructor Summary

Constructors

Constructor and Description
UBH()
UBH(java.lang.String spec) The constructor receiving the file or URL specification of a file containing the Univeral Binary Header.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File f) Return true if file is accepted.
protected void	createDefaultPropertySet(java.lang.String spec, int numSignals) Set the default properties.
BinaryFormatInterface	getBinaryFormat() The binary format description.
int	getBlockCount() Block count.
int	getBlocking() Blocking, 1=channel multiplexed, e.g. 512=blockmultiplexed.
long	getBlockOffset(int signal, int datatype, int index) Get the byte offset of the block of the value belong to the given signal and index.
FwkColumnAccessInterface	getColumn(int no) Get columns.
FwkColumnAccessInterface[]	getColumns() Get columns.
int	getCountPerSignal() Get the total number of values per signal.
java.lang.String	getCreatedOnPlatform() Get the platform that created the data.
int	getDebugLevel() The debug level.
java.lang.String	getDescription() The description of this filter.
long	getOffset(int signal, int datatype, int index) Get the byte offset of the value belong to the given signal and index.
SignalInterface	getSignal(int no) Get a signal.
int	getSignalCount() get the signal count.
static int	getValueByteCount(int dataType) Get the total number of bytes need in file for one value.
java.lang.String	getVersion() The revision number.
static void	main(java.lang.String[] args) Main module of this application.
FwkPropertyGroupInterface	read(java.io.InputStream is) Read the header file.
FwkColumnAccessInterface[]	read(java.lang.String spec, java.io.InputStream unused) Read columns from stream.
protected void	readHeader(java.lang.String spec) Read the header from file.
void	release() Release the header.
java.lang.String	toString() Print out the string presentation of the class.

Methods inherited from class com.highqsoft.fwk.FwkFileFilter

accept, addExtension, getExtension, isExtensionListInDescription, setDescription, setExtensionListInDescription, setPattern

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkFileFilterInterface

accept

Field Detail

C_DATATYPES

public static final java.lang.String[] C_DATATYPES

DT_USHORT

public static final int DT_USHORT

See Also:

Constant Field Values

DT_SHORT

public static final int DT_SHORT

See Also:

Constant Field Values

DT_UCHAR

public static final int DT_UCHAR

See Also:

Constant Field Values

DT_CHAR

public static final int DT_CHAR

See Also:

Constant Field Values

DT_INT

public static final int DT_INT

See Also:

Constant Field Values

DT_UINT

public static final int DT_UINT

See Also:

Constant Field Values

DT_LONG

public static final int DT_LONG

See Also:

Constant Field Values

DT_ULONG

public static final int DT_ULONG

See Also:

Constant Field Values

DT_FLOAT

public static final int DT_FLOAT

See Also:

Constant Field Values

DT_DOUBLE

public static final int DT_DOUBLE

See Also:

Constant Field Values

COMMENT

public static final java.lang.String COMMENT

See Also:

Constant Field Values

C_DATATYPENAME

public static final java.lang.String C_DATATYPENAME

See Also:

Constant Field Values

DATATYPE

public static final java.lang.String DATATYPE

See Also:

Constant Field Values

C_DATATYPE_UNKNOWN

public static final java.lang.String C_DATATYPE_UNKNOWN

See Also:

Constant Field Values

propertyGroup

protected FwkPropertyGroupInterface propertyGroup

binaryFormat

protected BinaryFormat binaryFormat

signals

protected SignalInterface[] signals

columns

protected FwkColumnAccessInterface[] columns

signalOffset

protected long[] signalOffset

signalCount

protected int signalCount

dataFile

protected java.lang.String dataFile

ubhFile

protected java.lang.String ubhFile

path

protected java.lang.String path

name

protected java.lang.String name

blocking

protected int blocking

blockCount

protected int blockCount

sectionSize

protected int sectionSize

Constructor Detail

UBH

public UBH()

UBH

public UBH(java.lang.String spec)
    throws java.io.IOException,
           java.io.FileNotFoundException

The constructor receiving the file or URL specification of a file containing the Univeral Binary Header.

Parameters:

spec - the resource location of the header.

Throws:

java.io.IOException

java.io.FileNotFoundException

Method Detail

readHeader

protected void readHeader(java.lang.String spec)
                   throws java.io.IOException,
                          java.io.FileNotFoundException

Read the header from file.

Parameters:

sepc - the file specification.

Throws:

java.io.IOException

java.io.FileNotFoundException

createDefaultPropertySet

protected void createDefaultPropertySet(java.lang.String spec,
                            int numSignals)

Set the default properties.

release

public void release()

Release the header.

Specified by:

release in interface FwkInterface

accept

public boolean accept(java.io.File f)

Return true if file is accepted.

Specified by:

accept in interface FwkFileFilterInterface

Overrides:

accept in class FwkFileFilter

Parameters:

f - The file to be checked.

Returns:

True id file is acepted.

See Also:

FwkFileFilter.getExtension(java.io.File), FileFilter#accepts

getDescription

public java.lang.String getDescription()

The description of this filter.

Specified by:

getDescription in interface FwkFileFilterInterface

Overrides:

getDescription in class FwkFileFilter

Returns:

the description.

See Also:

setDescription, setExtensionListInDescription, isExtensionListInDescription, FileFilter.getDescription()

getOffset

public long getOffset(int signal,
             int datatype,
             int index)

Get the byte offset of the value belong to the given signal and index.

Specified by:

getOffset in interface UBHInterface

Parameters:

signal - the signal number.

datatype - the signal data type.

index - The index of the requested value.

Returns:

the offset -1 if value is not available.

getBlockOffset

public long getBlockOffset(int signal,
                  int datatype,
                  int index)

Get the byte offset of the block of the value belong to the given signal and index.

Specified by:

getBlockOffset in interface UBHInterface

Parameters:

signal - the signal number.

datatype - the signal data type.

index - The index of the requested value.

Returns:

the offset -1 if value is not available.

getValueByteCount

public static int getValueByteCount(int dataType)

Get the total number of bytes need in file for one value.

Returns:

the byte count.

getVersion

public java.lang.String getVersion()

The revision number.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkFileFilter

Returns:

the version of the given header file.

getDebugLevel

public int getDebugLevel()

The debug level.

Specified by:

getDebugLevel in interface UBHInterface

Returns:

the debug level.

getBinaryFormat

public BinaryFormatInterface getBinaryFormat()

The binary format description.

Specified by:

getBinaryFormat in interface UBHInterface

Returns:

the binary format.

getSignalCount

public int getSignalCount()

get the signal count.

Specified by:

getSignalCount in interface UBHInterface

Returns:

the total number of described signals.

getSignal

public SignalInterface getSignal(int no)

Get a signal.

Specified by:

getSignal in interface UBHInterface

Parameters:

no - the number of the signal (starts at 0).

Returns:

the signal description.

toString

public java.lang.String toString()

Print out the string presentation of the class.

Overrides:

toString in class java.lang.Object

Returns:

the string presentation.

getColumn

public FwkColumnAccessInterface getColumn(int no)

Get columns.

Specified by:

getColumn in interface UBHInterface

Returns:

an array of column belongs to this header.

getCreatedOnPlatform

public java.lang.String getCreatedOnPlatform()

Get the platform that created the data.

Specified by:

getCreatedOnPlatform in interface UBHInterface

Returns:

the platform string, currently there are PC, UNIX and VMX swupported. The default is UNIX.

getColumns

public FwkColumnAccessInterface[] getColumns()

Get columns.

Specified by:

getColumns in interface UBHInterface

Returns:

an array of column belongs to this header.

read

public FwkColumnAccessInterface[] read(java.lang.String spec,
                              java.io.InputStream unused)
                                throws java.lang.RuntimeException

Read columns from stream.

Specified by:

read in interface FwkReadColumnsFromStreamInterface

Parameters:

is - The input stream from that the column should be read.

Returns:

the columns read from file.

Throws:

an - exception when ever a problem occurs.

java.lang.RuntimeException

getBlocking

public int getBlocking()

Blocking, 1=channel multiplexed, e.g. 512=blockmultiplexed.

Specified by:

getBlocking in interface UBHInterface

Returns:

the blocking size

getBlockCount

public int getBlockCount()

Block count.

Specified by:

getBlockCount in interface UBHInterface

Returns:

the totall numbr of blocks.

getCountPerSignal

public int getCountPerSignal()

Get the total number of values per signal.

Specified by:

getCountPerSignal in interface UBHInterface

Returns:

the total number of value.

read

public FwkPropertyGroupInterface read(java.io.InputStream is)
                               throws java.io.IOException

Read the header file.

Parameters:

is - the input stream.

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

Main module of this application. Normally this application is started via FwkFrame, FwkApplet or FwkApplication. In case somebody wants to run this application directly, this main method is provided. All it does is passing the responsibility directly to FwkFrame.