Package org.aavso.tools.vstar.util

Class ObservationInserter

java.lang.Object

org.aavso.tools.vstar.input.AbstractObservationRetriever

org.aavso.tools.vstar.util.ObservationInserter

public class ObservationInserter
extends AbstractObservationRetriever

Minimally overridden retriever that can be used to maintain observation order when user defined observations are added to the initial observation set. It's a slight abuse of this base class and arguably the addValidObservation() method called by updateObservationsList() should be factored out of the retriever base class. Yet it has the desired effect without code duplication.

Field Summary

Fields inherited from class org.aavso.tools.vstar.input.AbstractObservationRetriever

DEFAULT_CAPACITY, interrupted, invalidObservations, jdFlavour, MAGNITUDE, NO_VELA_FILTER, validObservationCategoryMap, validObservations

Constructor Summary

Constructors

Constructor	Description
ObservationInserter()
ObservationInserter(List<ValidObservation> observations)

Method Summary

Modifier and Type	Method	Description
List<ValidObservation>	addValidObservations(List<ValidObservation> observations)	Add observations to the current list, maintaining ordering, also keeping track of min/max magnitude values, accessible via get{Min,Max}Mag() methods.
String	getSourceName()	Retrieve the name of the source of the observations.
String	getSourceType()	Retrieve the type of the source of the observations.
void	retrieveObservations()	Retrieve the set of observations from the specified source.

Methods inherited from class org.aavso.tools.vstar.input.AbstractObservationRetriever

addAllInvalidObservations, addInvalidObservation, addValidObservation, collectAllObservations, collectObservation, getBrightnessUnits, getDomainTitle, getInvalidObservations, getJDflavour, getMaxMag, getMinMag, getNumberOfRecords, getRangeTitle, getStarInfo, getTimeUnits, getValidObservationCategoryMap, getValidObservations, incrementProgress, incrementProgress, insertObservation, isBarycentric, isHeliocentric, removeNegativeBytes, seriesToExcludeWhenAdditive, setBarycentric, setHeliocentric, setJDflavour, setMaxMag, setMinMag, setVelaFilter, wasInterrupted

Methods inherited from class java.lang.Object

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

Constructor Details

ObservationInserter

public ObservationInserter()

ObservationInserter

public ObservationInserter(List<ValidObservation> observations)

Method Details

addValidObservations

public List<ValidObservation> addValidObservations(List<ValidObservation> observations)

Add observations to the current list, maintaining ordering, also keeping track of min/max magnitude values, accessible via get{Min,Max}Mag() methods.

Parameters:

observations - The observations to be added.

Returns:

The complete updated list of observations.

retrieveObservations

public void retrieveObservations()
                          throws ObservationReadError,
InterruptedException

Description copied from class: AbstractObservationRetriever

Retrieve the set of observations from the specified source.

Specified by:

retrieveObservations in class AbstractObservationRetriever

Throws:

ObservationReadError

InterruptedException

getSourceType

public String getSourceType()

Description copied from class: AbstractObservationRetriever

Retrieve the type of the source of the observations.

Specified by:

getSourceType in class AbstractObservationRetriever

Returns:

The source type.

getSourceName

public String getSourceName()

Description copied from class: AbstractObservationRetriever

Retrieve the name of the source of the observations.

Specified by:

getSourceName in class AbstractObservationRetriever

Returns:

The source name.