edu.sc.seis.fissuresUtil.xml
Interface DataSet

All Superinterfaces:

StdDataSetParamNames

All Known Implementing Classes:

MemoryDataSet, URLDataSet, XMLDataSet

public interface DataSet
extends StdDataSetParamNames

Field Summary

Fields inherited from interface edu.sc.seis.fissuresUtil.xml.StdDataSetParamNames

CHANNEL, EVENT, prefix

Method Summary

void	addDataSet(DataSet dataset, AuditInfo[] audit) adds the given DataSet as a child of this one
void	addDataSetSeismogram(DataSetSeismogram dss, AuditInfo[] audit) adds the DataSetSeismogram to this DataSet.
void	addParameter(java.lang.String name, java.lang.Object param, AuditInfo[] audit)
DataSet	createChildDataSet(java.lang.String id, java.lang.String name, java.lang.String owner, AuditInfo[] audit) Creates a new data set and adds it to this one as a child
Channel	getChannel(ChannelId channelId) Optional method to get the channel from the parameters, if it exists.
ChannelId[]	getChannelIds() Optional method to get channel id of all Channel parameters.
DataSet	getDataSet(java.lang.String name)
java.lang.String[]	getDataSetNames() Can be used in conjunction with getDataSet to get all of the datasets held by this one
DataSetSeismogram	getDataSetSeismogram(java.lang.String seismogramName)
java.lang.String[]	getDataSetSeismogramNames()
EventAccessOperations	getEvent() Optional method to get the event associated with this dataset.
java.lang.String	getId()
java.lang.String	getName()
java.lang.String	getOwner()
java.lang.Object	getParameter(java.lang.String name)
java.lang.String[]	getParameterNames()
void	remove(DataSetSeismogram dss)
void	setName(java.lang.String name)
void	setOwner(java.lang.String owner)

Method Detail

getId

java.lang.String getId()

getName

java.lang.String getName()

setOwner

void setOwner(java.lang.String owner)

getOwner

java.lang.String getOwner()

setName

void setName(java.lang.String name)

getParameterNames

java.lang.String[] getParameterNames()

getParameter

java.lang.Object getParameter(java.lang.String name)

addParameter

void addParameter(java.lang.String name,
                  java.lang.Object param,
                  AuditInfo[] audit)

getDataSetNames

java.lang.String[] getDataSetNames()

Can be used in conjunction with getDataSet to get all of the datasets held by this one

Returns:

the names of all directly held DataSetSeismograms

getDataSet

DataSet getDataSet(java.lang.String name)

Returns:

a DataSet with the given name

addDataSet

void addDataSet(DataSet dataset,
                AuditInfo[] audit)

adds the given DataSet as a child of this one

createChildDataSet

DataSet createChildDataSet(java.lang.String id,
                           java.lang.String name,
                           java.lang.String owner,
                           AuditInfo[] audit)

Creates a new data set and adds it to this one as a child

addDataSetSeismogram

void addDataSetSeismogram(DataSetSeismogram dss,
                          AuditInfo[] audit)

adds the DataSetSeismogram to this DataSet.

getDataSetSeismogram

DataSetSeismogram getDataSetSeismogram(java.lang.String seismogramName)

Returns:

the DataSetSeismogram inserted with this name

getDataSetSeismogramNames

java.lang.String[] getDataSetSeismogramNames()

Returns:

the names of all directly held DataSetSeismograms

remove

void remove(DataSetSeismogram dss)

getChannelIds

ChannelId[] getChannelIds()

Optional method to get channel id of all Channel parameters.

See Also:

for the prefix for these parameters.

getChannel

Channel getChannel(ChannelId channelId)

Optional method to get the channel from the parameters, if it exists. Should return null otherwise.

See Also:

for the prefix for these parameters.

getEvent

EventAccessOperations getEvent()

Optional method to get the event associated with this dataset. Not all datasets will have an event, return null in this case.

See Also:

for the prefix for these parameters.