org.javaseis.properties
Class PropertyDescription

java.lang.Object
  org.javaseis.properties.PropertyDescription

All Implemented Interfaces:

java.io.Serializable

public class PropertyDescription
extends java.lang.Object
implements java.io.Serializable

A description of trace properties.

See Also:

Serialized Form

Field Summary

protected int	_count
protected java.lang.String	_description
protected int	_format
protected int	_formatLength
protected java.lang.String[]	_formatStrings
protected java.lang.String	_label
protected int	_offset
protected int	_recordLength
static int	HDR_FORMAT_BYTE
static int	HDR_FORMAT_COMPLEX
static int	HDR_FORMAT_DCOMPLEX
static int	HDR_FORMAT_DOUBLE
static int	HDR_FORMAT_FLOAT
static int	HDR_FORMAT_INTEGER
static int	HDR_FORMAT_LONG
static int	HDR_FORMAT_SHORT
static int	HDR_FORMAT_STRING
static int	HDR_FORMAT_UNDEFINED
static int	HDR_OFFSET_UNDEFINED

Constructor Summary

PropertyDescription()

PropertyDescription(java.lang.String label, java.lang.String description, int format, int count)

Method Summary

PropertyDescription	clone() Clones the property.
protected void	computeLengths()
int	getCount()
java.lang.String	getDescription()
int	getFormat()
int	getFormatLength()
java.lang.String	getLabel()
int	getOffset()
int	getRecordLength()
void	set(java.lang.String label, java.lang.String propertyString) Sets the property label and description.
void	set(java.lang.String label, java.lang.String description, int format, int count, int offset)
void	setOffset(int offset)
java.lang.String	toPropertyString() Converts the property general decription to a string.

Methods inherited from class java.lang.Object

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

Field Detail

_count

protected int _count

_description

protected java.lang.String _description

_format

protected int _format

_formatLength

protected int _formatLength

_formatStrings

protected java.lang.String[] _formatStrings

_label

protected java.lang.String _label

_offset

protected int _offset

_recordLength

protected int _recordLength

HDR_FORMAT_BYTE

public static final int HDR_FORMAT_BYTE

See Also:

Constant Field Values

HDR_FORMAT_COMPLEX

public static final int HDR_FORMAT_COMPLEX

See Also:

Constant Field Values

HDR_FORMAT_DCOMPLEX

public static final int HDR_FORMAT_DCOMPLEX

See Also:

Constant Field Values

HDR_FORMAT_DOUBLE

public static final int HDR_FORMAT_DOUBLE

See Also:

Constant Field Values

HDR_FORMAT_FLOAT

public static final int HDR_FORMAT_FLOAT

See Also:

Constant Field Values

HDR_FORMAT_INTEGER

public static final int HDR_FORMAT_INTEGER

See Also:

Constant Field Values

HDR_FORMAT_LONG

public static final int HDR_FORMAT_LONG

See Also:

Constant Field Values

HDR_FORMAT_SHORT

public static final int HDR_FORMAT_SHORT

See Also:

Constant Field Values

HDR_FORMAT_STRING

public static final int HDR_FORMAT_STRING

See Also:

Constant Field Values

HDR_FORMAT_UNDEFINED

public static final int HDR_FORMAT_UNDEFINED

See Also:

Constant Field Values

HDR_OFFSET_UNDEFINED

public static final int HDR_OFFSET_UNDEFINED

See Also:

Constant Field Values

Constructor Detail

PropertyDescription

public PropertyDescription()

PropertyDescription

public PropertyDescription(java.lang.String label,
                           java.lang.String description,
                           int format,
                           int count)

Method Detail

clone

public PropertyDescription clone()

Clones the property.

Overrides:

clone in class java.lang.Object

Returns:

The cloned property.

computeLengths

protected void computeLengths()

getCount

public int getCount()

getDescription

public java.lang.String getDescription()

getFormat

public int getFormat()

getFormatLength

public int getFormatLength()

getLabel

public java.lang.String getLabel()

getOffset

public int getOffset()

getRecordLength

public int getRecordLength()

set

public void set(java.lang.String label,
                java.lang.String propertyString)
         throws SeisException

Sets the property label and description.

Parameters:

label - The property label name.

s - The string from which to extract the property general description.

Throws:

SeisException - Thrown on string parsing errors.

set

public void set(java.lang.String label,
                java.lang.String description,
                int format,
                int count,
                int offset)

setOffset

public void setOffset(int offset)

toPropertyString

public java.lang.String toPropertyString()

Converts the property general decription to a string.

Returns:

The general description string.