org.hps.conditions.api

Interface ConditionsObjectCollection<ObjectType extends ConditionsObject>

Type Parameters:

ObjectType - the type of the objects

All Superinterfaces:

DatabaseObject, Iterable<ObjectType>

All Known Implementing Classes:

AbstractSvtChannel.AbstractSvtChannelCollection, AbstractSvtDaqMapping.AbstractSvtDaqMappingCollection, AbstractSvtT0Shift.AbstractSvtT0ShiftCollection, BaseConditionsObjectCollection, BeamEnergy.BeamEnergyCollection, ConditionsRecord.ConditionsRecordCollection, ConditionsTag.ConditionsTagCollection, DummyConditionsObject.DummyConditionsObjectCollection, EcalBadChannel.EcalBadChannelCollection, EcalCalibration.EcalCalibrationCollection, EcalChannel.EcalChannelCollection, EcalCrystalPosition.EcalCrystalPositionCollection, EcalGain.EcalGainCollection, EcalLed.EcalLedCollection, EcalLedCalibration.EcalLedCalibrationCollection, EcalPulseWidth.EcalPulseWidthCollection, EcalTimeShift.EcalTimeShiftCollection, EcalTimeWalk.EcalTimeWalkCollection, SvtAlignmentConstant.SvtAlignmentConstantCollection, SvtBadChannel.SvtBadChannelCollection, SvtBiasConstant.SvtBiasConstantCollection, SvtCalibration.SvtCalibrationCollection, SvtChannel.SvtChannelCollection, SvtConfiguration.SvtConfigurationCollection, SvtDaqMapping.SvtDaqMappingCollection, SvtGain.SvtGainCollection, SvtMotorPosition.SvtMotorPositionCollection, SvtShapeFitParameters.SvtShapeFitParametersCollection, SvtT0Shift.SvtT0ShiftCollection, SvtTimingConstants.SvtTimingConstantsCollection, TestRunSvtChannel.TestRunSvtChannelCollection, TestRunSvtDaqMapping.TestRunSvtDaqMappingCollection, TestRunSvtT0Shift.TestRunSvtT0ShiftCollection, TiTimeOffset.TiTimeOffsetCollection, TriggerTimeWindow.TriggerTimeWindowCollection

public interface ConditionsObjectCollection<ObjectType extends ConditionsObject>
extends Iterable<ObjectType>, DatabaseObject

Interface representing a collection of conditions objects.

Author:

Jeremy McCormick, SLAC

Method Summary

Modifier and Type	Method and Description
boolean	add(ObjectType object) Add an object to the collection.
void	addAll(ConditionsObjectCollection<ObjectType> collection) Add all objects to the collection.
void	clear() Clear the objects from this collection and reset its ID.
boolean	contains(Object object) Return true if collection contains this object.
ObjectType	get(int index) Get an object by index.
int	getCollectionId() Get the collection ID.
void	loadCsv(File file) Load collection from a CSV file.
void	setCollectionId(int collectionId) Set the collection ID.
int	size() Get the size of the collection.
void	sort(Comparator<ObjectType> comparator) Sort the collection in place.
ConditionsObjectCollection<ObjectType>	sorted(Comparator<ObjectType> comparator) Get a sorted copy of the collection, leaving the original in place.
void	writeCsv(File file) Write the collection contents to a text file.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.hps.conditions.api.DatabaseObject

delete, getTableMetaData, insert, isNew, select, setConnection, setTableMetaData, update

Method Detail

add

boolean add(ObjectType object)
     throws ConditionsObjectException

Add an object to the collection.

Parameters:

object - the object to add to the collection

Returns:

true if object was added successfully

Throws:

ConditionsObjectException - if there was an error adding the object

addAll

void addAll(ConditionsObjectCollection<ObjectType> collection)

Add all objects to the collection.

Parameters:

collection - the source collection with objects to add

clear

void clear()

Clear the objects from this collection and reset its ID.

This has no effect on the underlying database values.

contains

boolean contains(Object object)

Return true if collection contains this object.

Parameters:

object - the object to check

Returns:

true if the collection contains the object

get

ObjectType get(int index)

Get an object by index.

Parameters:

index - the index of the object

Returns:

the object

getCollectionId

int getCollectionId()

Get the collection ID.

Returns:

the collection ID

loadCsv

void loadCsv(File file)
      throws IOException,
             FileNotFoundException,
             ConditionsObjectException

Load collection from a CSV file.

Parameters:

file - the input CSV file

Throws:

IOException - if there is an error closing the reader

FileNotFoundException - if the input file does not exist

ConditionsObjectException - if there is an error creating a conditions object

setCollectionId

void setCollectionId(int collectionId)

Set the collection ID.

Parameters:

collectionId - the new collection ID

size

int size()

Get the size of the collection.

Returns:

the size of the collection

sort

void sort(Comparator<ObjectType> comparator)

Sort the collection in place.

Parameters:

comparator - the comparison operator to use for sorting

sorted

ConditionsObjectCollection<ObjectType> sorted(Comparator<ObjectType> comparator)

Get a sorted copy of the collection, leaving the original in place.

Parameters:

comparator - the comparison operator to use

Returns:

the sorted copy of the collection

writeCsv

void writeCsv(File file)
       throws IOException

Write the collection contents to a text file.

Parameters:

file - the output text file

Throws:

IOException