moos.ssds.model
Class RecordDescription

java.lang.Object
  moos.ssds.model.RecordDescription

All Implemented Interfaces:

IRecordDescription, java.io.Serializable, ValueObject

public class RecordDescription

extends java.lang.Object

implements java.io.Serializable, ValueObject, IRecordDescription

Version:

: $Revision: 1.10 $

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement. This information should not be published or distributed to third parties without specific written permission from MBARI.

Copyright 2002 MBARI.
MBARI Proprietary Information. All rights reserved.

Author:

: $Author: kgomes $

See Also:

Serialized Form

Field Summary

Fields inherited from interface moos.ssds.model.IRecordDescription

ASCII_BUFFERSTYLE, BIG_ENDIAN, BINARY_BUFFERSTYLE, FIXED_BUFFERLENGTH, LITTLE_ENDIAN, VARIABLE_BUFFERLENGTH

Constructor Summary

RecordDescription()

RecordDescription(IRecordDescription r)
Copy constructor

Method Summary

void	addRecordVariable(IRecordVariable recordVariable)
java.lang.String	getBufferItemSeparator()
java.lang.String	getBufferLengthType()
java.lang.String	getBufferStyle()
java.lang.String	getEndian()
java.lang.Long	getId()
java.lang.String	getRecordTerminator()
java.lang.Long	getRecordType()
boolean	isParseable()
java.util.Collection	listRecordVariables()
void	removeRecordVariable(IRecordVariable variable)
void	setBufferItemSeparator(java.lang.String bufferItemSeperator)
void	setBufferLengthType(java.lang.String bufferLengthType)
void	setBufferStyle(java.lang.String bufferStyle)
void	setDataContainer(IDataContainer dataContainer) This is package local on purpose.
void	setEndian(java.lang.String endian)
void	setId(java.lang.Long id)
void	setParseable(boolean parseable)
void	setRecordTerminator(java.lang.String recordTerminator)
void	setRecordType(java.lang.Long recordType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordDescription

public RecordDescription()

RecordDescription

public RecordDescription(IRecordDescription r)

Copy constructor

Method Detail

listRecordVariables

public java.util.Collection listRecordVariables()

Specified by:

listRecordVariables in interface IRecordDescription

addRecordVariable

public void addRecordVariable(IRecordVariable recordVariable)

Specified by:

addRecordVariable in interface IRecordDescription

removeRecordVariable

public void removeRecordVariable(IRecordVariable variable)

Specified by:

removeRecordVariable in interface IRecordDescription

getBufferStyle

public java.lang.String getBufferStyle()

Specified by:

getBufferStyle in interface IRecordDescription

setBufferStyle

public void setBufferStyle(java.lang.String bufferStyle)

Specified by:

setBufferStyle in interface IRecordDescription

getEndian

public java.lang.String getEndian()

Specified by:

getEndian in interface IRecordDescription

setEndian

public void setEndian(java.lang.String endian)

Specified by:

setEndian in interface IRecordDescription

getBufferItemSeparator

public java.lang.String getBufferItemSeparator()

Specified by:

getBufferItemSeparator in interface IRecordDescription

setBufferItemSeparator

public void setBufferItemSeparator(java.lang.String bufferItemSeperator)

Specified by:

setBufferItemSeparator in interface IRecordDescription

getRecordTerminator

public java.lang.String getRecordTerminator()

Specified by:

getRecordTerminator in interface IRecordDescription

setRecordTerminator

public void setRecordTerminator(java.lang.String recordTerminator)

Specified by:

setRecordTerminator in interface IRecordDescription

getBufferLengthType

public java.lang.String getBufferLengthType()

Specified by:

getBufferLengthType in interface IRecordDescription

setBufferLengthType

public void setBufferLengthType(java.lang.String bufferLengthType)

Specified by:

setBufferLengthType in interface IRecordDescription

isParseable

public boolean isParseable()

Specified by:

isParseable in interface IRecordDescription

setParseable

public void setParseable(boolean parseable)

Specified by:

setParseable in interface IRecordDescription

toString

public java.lang.String toString()

Specified by:

toString in interface IRecordDescription

Returns:

WARNING: Format of the string may change in the future!!

getId

public java.lang.Long getId()

Specified by:

getId in interface ValueObject

setId

public void setId(java.lang.Long id)

Specified by:

setId in interface ValueObject

setDataContainer

public void setDataContainer(IDataContainer dataContainer)

This is package local on purpose. It should only be called by DataContainer.addRecordDescription().

Specified by:

setDataContainer in interface IRecordDescription

Parameters:

dataContainer -

getRecordType

public java.lang.Long getRecordType()

Specified by:

getRecordType in interface IRecordDescription

setRecordType

public void setRecordType(java.lang.Long recordType)

Specified by:

setRecordType in interface IRecordDescription