edu.unh.sdb.datasource
Class ForeignReferenceDataSource

java.lang.Object
  edu.unh.sdb.datasource.DataCollection
      edu.unh.sdb.datasource.DataSource
          edu.unh.sdb.datasource.ForeignReferenceDataSource

All Implemented Interfaces:

Indexable

public class ForeignReferenceDataSource
extends DataSource

Field Summary

protected java.lang.String	dbName
protected DataSource	referent

Fields inherited from class edu.unh.sdb.datasource.DataSource

fdlDescriptor, isActivated, name, wsName

Fields inherited from class edu.unh.sdb.datasource.DataCollection

attributeOrder, axisOrdering, axisWeights, bounds, dataOrder, dimensionality, numAttributes, pointOrder, recordDesc

Constructor Summary

ForeignReferenceDataSource(java.lang.String name, java.lang.String dbName, DataSource referent)

Method Summary

void	activate() The DataSource will perform any initialization required in order to begin reading/processing data.
void	datum(Datum dtm, IndexSpaceID did) Return by reference the Datum corresponding to the given IndexSpaceID.
void	datum(Datum dtm, IndexSpaceID did, FieldIDMapper mp) Get the Datum and fill its values in the passed Datum at positions specified by the corresponding FieldIDMapper.
void	datum(Datum dtm, IndexSpaceID did, RecordSpec recSpec) Get the Datum and fill its values in the passed Datum at positions specified by the corresponding RecordSpec.
void	deactivate() The DataSource will release any resources used during the readling or processing of data.
java.lang.String	getDBName()
java.lang.String	getName() Returns the name of this DataSource object.
void	subblock(DataBlock theBlock, ISBounds dstBounds, ISBounds srcBounds) Reads a subblock defined by srcBounds into the region of the Datablock argument defined by dstBounds.
void	subblock(DataBlock theBlock, ISBounds dstBounds, ISBounds srcBounds, FieldIDMapper mp) Reads a subblock defined by srcBounds into the region of the Datablock argument defined by dstBounds.
void	subblock(DataBlock theBlock, ISBounds dstBounds, ISBounds srcBounds, RecordSpec spec) Reads a subblock defined by srcBounds into the region of the Datablock argument defined by dstBounds.

Methods inherited from class edu.unh.sdb.datasource.DataSource

checkActivated, clearCache, copyBestID, create, create, create, createRemote, createRemote, createRemoteClient, createRemoteClient, createRemoteDataSource, createRemoteDataSource, createRemoteDataSourceUDP, createRemoteUDP, createRemoteUDP, dumpData, equals, getValues, isActivated, main, toString, toString

Methods inherited from class edu.unh.sdb.datasource.DataCollection

byteSize, computeOffset, computeOffset, copyBounds, createDataBlock, createDataBlock, createDataBlock, createDatum, createDatum, createDatum, createDatum, createDatum, createDatum, datum, datum, datum, datum, dim, getAxisOrdering, getAxisWeight, getAxisWeights, getBounds, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getBytesByAttribute, getBytesByAttribute, getBytesByPoint, getBytesByPoint, getDataOrder, getDimensionsArray, getDouble, getDoubles, getDoubles, getDoubles, getDoubles, getDoubles, getDoubles, getDoublesByAttribute, getDoublesByAttribute, getDoublesByPoint, getDoublesByPoint, getFloat, getFloats, getFloats, getFloats, getFloats, getFloats, getFloats, getFloatsByAttribute, getFloatsByAttribute, getFloatsByPoint, getFloatsByPoint, getInt, getInts, getInts, getInts, getInts, getInts, getInts, getIntsByAttribute, getIntsByAttribute, getIntsByPoint, getIntsByPoint, getLowerBoundsArray, getNumAttributes, getRecordDescriptor, getShort, getShorts, getShorts, getShorts, getShorts, getShorts, getShorts, getShortsByAttribute, getShortsByAttribute, getShortsByPoint, getShortsByPoint, getStorageType, getValues, getValuesByAttribute, getValuesByPoint, longVolume, setAxisOrdering, setBounds, setRecordDescriptor, size, subblock, subblock, subblock, subblock, subblock, subblock, subblock, subblock, subblock, useBytesOnly, volume

Methods inherited from class java.lang.Object

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

Field Detail

dbName

protected java.lang.String dbName

referent

protected DataSource referent

Constructor Detail

ForeignReferenceDataSource

public ForeignReferenceDataSource(java.lang.String name,
                                  java.lang.String dbName,
                                  DataSource referent)

Method Detail

getName

public java.lang.String getName()

Description copied from class: DataSource

Returns the name of this DataSource object.

Overrides:

getName in class DataSource

getDBName

public java.lang.String getDBName()

activate

public void activate()

Description copied from class: DataSource

The DataSource will perform any initialization required in order to begin reading/processing data. It is important that all child classes call super.activate()

Overrides:

activate in class DataSource

deactivate

public void deactivate()

The DataSource will release any resources used during the readling or processing of data.

Overrides:

deactivate in class DataSource

datum

public void datum(Datum dtm,
                  IndexSpaceID did)

Return by reference the Datum corresponding to the given IndexSpaceID.

Specified by:

datum in interface Indexable

Overrides:

datum in class DataCollection

datum

public void datum(Datum dtm,
                  IndexSpaceID did,
                  FieldIDMapper mp)

Get the Datum and fill its values in the passed Datum at positions specified by the corresponding FieldIDMapper.

Specified by:

datum in interface Indexable

Specified by:

datum in class DataCollection

datum

public void datum(Datum dtm,
                  IndexSpaceID did,
                  RecordSpec recSpec)

Get the Datum and fill its values in the passed Datum at positions specified by the corresponding RecordSpec.

Specified by:

datum in interface Indexable

Overrides:

datum in class DataCollection

subblock

public void subblock(DataBlock theBlock,
                     ISBounds dstBounds,
                     ISBounds srcBounds)

Description copied from class: DataCollection

Reads a subblock defined by srcBounds into the region of the Datablock argument defined by dstBounds.

Specified by:

subblock in interface Indexable

Specified by:

subblock in class DataCollection

subblock

public void subblock(DataBlock theBlock,
                     ISBounds dstBounds,
                     ISBounds srcBounds,
                     FieldIDMapper mp)

Description copied from class: DataCollection

Reads a subblock defined by srcBounds into the region of the Datablock argument defined by dstBounds. The FieldIDMapper argument determines the mapping between datums in this DataBlock and datums in the argument DataBlock. It is legal to pass a null for the FieldIDMapper argument which means that all attributes are to be extracted.

Specified by:

subblock in interface Indexable

Specified by:

subblock in class DataCollection

subblock

public void subblock(DataBlock theBlock,
                     ISBounds dstBounds,
                     ISBounds srcBounds,
                     RecordSpec spec)

Description copied from class: DataCollection

Reads a subblock defined by srcBounds into the region of the Datablock argument defined by dstBounds. The RecordSpec argument specifies a subset of the attributes of this DataSource to be written into the DataBlock datums. It is legal to pass a null for the RecordSpec argument which means that all attributes are to be extracted.

Specified by:

subblock in interface Indexable

Overrides:

subblock in class DataCollection