edu.sc.seis.fissuresUtil.xml
Class DataSetSeismogram

java.lang.Object
  extended by edu.sc.seis.fissuresUtil.xml.DataSetSeismogram
All Implemented Interfaces:
LocalDataCenterCallBack, StdAuxillaryDataNames, java.lang.Cloneable
Direct Known Subclasses:
DCDataSetSeismogram, FilteredDataSetSeismogram, MemoryDataSetSeismogram, URLDataSetSeismogram

public abstract class DataSetSeismogram
extends java.lang.Object
implements LocalDataCenterCallBack, java.lang.Cloneable, StdAuxillaryDataNames

DataSetSeismogram.java Created: Tue Feb 11 10:08:37 2003


Field Summary
protected  java.util.List seisCache
           
protected  edu.iris.Fissures.Unit y_unit
           
 
Fields inherited from interface edu.sc.seis.fissuresUtil.xml.StdAuxillaryDataNames
APPROVED, CHANNEL_BEGIN, NETWORK_BEGIN, PICK_FLAG, prefix, RESPONSE
 
Constructor Summary
DataSetSeismogram(DataSet ds, java.lang.String name)
           
DataSetSeismogram(DataSet ds, java.lang.String name, edu.iris.Fissures.IfSeismogramDC.RequestFilter requestFilter)
           
 
Method Summary
 void addAuxillaryData(java.lang.Object key, java.lang.Object value)
           
 void addRequestFilterChangeListener(RequestFilterChangeListener listener)
           
 void addSeisDataChangeListener(SeisDataChangeListener dataListener)
           
protected  void addToCache(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl seismogram)
           
protected  void addToCache(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl[] seismograms)
           
 java.lang.Object clone()
           
static boolean equalOrContains(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl one, edu.iris.Fissures.seismogramDC.LocalSeismogramImpl two)
           
 boolean equals(java.lang.Object other)
           
 void error(SeisDataChangeListener initiator, java.lang.Throwable e)
          Informs the callback object that it is done with the processing of its request for seismograms because it encountered a problem.
 void finished(SeisDataChangeListener initiator)
          Informs the callback object that it is done with the processing of its request for seismograms.
protected  void fireBeginTimeChangedEvent()
           
protected  void fireDataErrorEvent(SeisDataErrorEvent event)
           
protected  void fireDataFinishedEvent(SeisDataChangeEvent event)
           
protected  void fireEndTimeChangedEvent()
           
protected  void fireNewDataEvent(SeisDataChangeEvent event)
           
static java.lang.String generateName(edu.iris.Fissures.IfNetwork.Channel chan)
           
protected  java.lang.String getAutogeneratedName()
           
 java.lang.Object getAuxillaryData(java.lang.Object key)
           
 java.util.Collection getAuxillaryDataKeys()
           
 edu.iris.Fissures.model.MicroSecondDate getBeginMicroSecondDate()
           
 edu.iris.Fissures.Time getBeginTime()
           
 edu.iris.Fissures.IfNetwork.Channel getChannel()
           
 edu.iris.Fissures.IfNetwork.ChannelId getChannelId()
           
 DataSet getDataSet()
          gets the dataset to which this seismogram belongs.
protected  java.util.List getDSSDataListenersCopy()
           
 edu.iris.Fissures.model.MicroSecondDate getEndMicroSecondDate()
           
 edu.iris.Fissures.Time getEndTime()
           
 edu.iris.Fissures.IfEvent.EventAccessOperations getEvent()
           
 java.lang.String getName()
           
 edu.iris.Fissures.IfSeismogramDC.RequestFilter getRequestFilter()
          subclass may override this if they do not wish to use the internal requestFilter field.
protected  java.util.List getRFChangeListenersCopy()
           
 edu.iris.Fissures.Unit getYUnit()
           
 boolean isNameAutogenerated()
           
 void pushData(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl[] seismograms, SeisDataChangeListener initiator)
          used to push information about the seismograms to the callback object.
 java.lang.Object removeAuxillaryData(java.lang.Object key)
           
 void removeRequestFilterChangeListener(RequestFilterChangeListener listener)
           
 void removeSeisDataChangeListener(SeisDataChangeListener dataListener)
           
abstract  void retrieveData(SeisDataChangeListener dataListener)
           
 void setBeginTime(edu.iris.Fissures.Time time)
           
 void setDataSet(DataSet dataSet)
           
 void setEndTime(edu.iris.Fissures.Time time)
           
 void setName(java.lang.String name)
           
 void setYUnit(edu.iris.Fissures.Unit unit)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

seisCache

protected java.util.List seisCache

y_unit

protected edu.iris.Fissures.Unit y_unit
Constructor Detail

DataSetSeismogram

public DataSetSeismogram(DataSet ds,
                         java.lang.String name)

DataSetSeismogram

public DataSetSeismogram(DataSet ds,
                         java.lang.String name,
                         edu.iris.Fissures.IfSeismogramDC.RequestFilter requestFilter)
Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

getDataSet

public DataSet getDataSet()
gets the dataset to which this seismogram belongs. May be null if it does not belong to a dataset.


getChannel

public edu.iris.Fissures.IfNetwork.Channel getChannel()

getEvent

public edu.iris.Fissures.IfEvent.EventAccessOperations getEvent()

setDataSet

public void setDataSet(DataSet dataSet)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

isNameAutogenerated

public boolean isNameAutogenerated()

getAutogeneratedName

protected java.lang.String getAutogeneratedName()

generateName

public static java.lang.String generateName(edu.iris.Fissures.IfNetwork.Channel chan)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getBeginMicroSecondDate

public edu.iris.Fissures.model.MicroSecondDate getBeginMicroSecondDate()

getBeginTime

public edu.iris.Fissures.Time getBeginTime()

setBeginTime

public void setBeginTime(edu.iris.Fissures.Time time)

getEndMicroSecondDate

public edu.iris.Fissures.model.MicroSecondDate getEndMicroSecondDate()

getEndTime

public edu.iris.Fissures.Time getEndTime()

setEndTime

public void setEndTime(edu.iris.Fissures.Time time)

getRequestFilter

public edu.iris.Fissures.IfSeismogramDC.RequestFilter getRequestFilter()
subclass may override this if they do not wish to use the internal requestFilter field.


getChannelId

public edu.iris.Fissures.IfNetwork.ChannelId getChannelId()

getYUnit

public edu.iris.Fissures.Unit getYUnit()

setYUnit

public void setYUnit(edu.iris.Fissures.Unit unit)

addRequestFilterChangeListener

public void addRequestFilterChangeListener(RequestFilterChangeListener listener)

removeRequestFilterChangeListener

public void removeRequestFilterChangeListener(RequestFilterChangeListener listener)

getRFChangeListenersCopy

protected java.util.List getRFChangeListenersCopy()

getDSSDataListenersCopy

protected java.util.List getDSSDataListenersCopy()

fireEndTimeChangedEvent

protected void fireEndTimeChangedEvent()

fireBeginTimeChangedEvent

protected void fireBeginTimeChangedEvent()

addSeisDataChangeListener

public void addSeisDataChangeListener(SeisDataChangeListener dataListener)

removeSeisDataChangeListener

public void removeSeisDataChangeListener(SeisDataChangeListener dataListener)

fireNewDataEvent

protected void fireNewDataEvent(SeisDataChangeEvent event)

fireDataFinishedEvent

protected void fireDataFinishedEvent(SeisDataChangeEvent event)

fireDataErrorEvent

protected void fireDataErrorEvent(SeisDataErrorEvent event)

pushData

public void pushData(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl[] seismograms,
                     SeisDataChangeListener initiator)
Description copied from interface: LocalDataCenterCallBack
used to push information about the seismograms to the callback object.

Specified by:
pushData in interface LocalDataCenterCallBack
Parameters:
seismograms - - an array of LocalSeismogramImpl
initiator - - the callback object that initiated the request for seismograms.

addToCache

protected void addToCache(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl[] seismograms)

addToCache

protected void addToCache(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl seismogram)

equalOrContains

public static boolean equalOrContains(edu.iris.Fissures.seismogramDC.LocalSeismogramImpl one,
                                      edu.iris.Fissures.seismogramDC.LocalSeismogramImpl two)

finished

public void finished(SeisDataChangeListener initiator)
Description copied from interface: LocalDataCenterCallBack
Informs the callback object that it is done with the processing of its request for seismograms.

Specified by:
finished in interface LocalDataCenterCallBack
Parameters:
initiator - - the callback object that initiated the request for seismograms.

error

public void error(SeisDataChangeListener initiator,
                  java.lang.Throwable e)
Description copied from interface: LocalDataCenterCallBack
Informs the callback object that it is done with the processing of its request for seismograms because it encountered a problem.

Specified by:
error in interface LocalDataCenterCallBack
Parameters:
initiator - - the callback object that initiated the request for seismograms.
e - - the exception explaining the error encountered.

retrieveData

public abstract void retrieveData(SeisDataChangeListener dataListener)

addAuxillaryData

public void addAuxillaryData(java.lang.Object key,
                             java.lang.Object value)

getAuxillaryData

public java.lang.Object getAuxillaryData(java.lang.Object key)

removeAuxillaryData

public java.lang.Object removeAuxillaryData(java.lang.Object key)

getAuxillaryDataKeys

public java.util.Collection getAuxillaryDataKeys()