Interface IRecordHolder
- All Known Implementing Classes:
Table
public interface IRecordHolder
Interface for a container for one or more indexed records implementing
IRecord
.
Record holders' directly equivalent sources might include, e.g. a file of
data or a database table. The are contained in IDataset
objects
(e.g. representing directories or databases).
- Author:
- Andy Evans
- See Also:
IRecord
- Version: 1.0 01 Mar 2021
-
Method Summary
Modifier and Type Method Description void
addRecord(IRecord record)
Should add a singleIRecord
to the end of the holder.void
addRecords(ArrayList<IRecord> records)
Should add a collection ofIRecord
objects to the end of the container.ArrayList<String>
getFieldNames()
Should get the field names for thisRecordHolder
.ArrayList<Class>
getFieldTypes()
Should get the field types for thisRecordHolder
.IMetadata
getMetadata()
Should get the metadata for thisRecordHolder
.IDataset
getParentDataset()
Should return the dataset thisRecordHolder
is part of, or null if none.IRecord
getRecord(int index)
Should get a singleIRecord
at an index.ArrayList<IRecord>
getRecords()
Should get allIRecord
objects.void
setFieldNames(ArrayList<String> fieldNames)
Should set the field names for thisRecordHolder
.void
setFieldTypes(ArrayList<Class> fieldTypes)
Should set the field types for thisRecordHolder
.void
setMetadata(IMetadata metadata)
Should set the metadata for thisRecordHolder
.void
setRecord(int index, IRecord record)
Should set a singleIRecord
in the holder at index position.
-
Method Details
-
getParentDataset
IDataset getParentDataset()Should return the dataset thisRecordHolder
is part of, or null if none.- Returns:
- IDataset Parent data set or null.
-
setMetadata
Should set the metadata for thisRecordHolder
.- Parameters:
metadata
- The metadata object for thisRecordHolder
.
-
getMetadata
IMetadata getMetadata()Should get the metadata for thisRecordHolder
.- Returns:
- IMetadata The metadata object for this
RecordHolder
.
-
setFieldNames
Should set the field names for thisRecordHolder
.- Parameters:
fieldNames
- The field names for thisRecordHolder
.
-
getFieldNames
Should get the field names for thisRecordHolder
.- Returns:
- ArrayList The field names for this
RecordHolder
.
-
setFieldTypes
Should set the field types for thisRecordHolder
.- Parameters:
fieldTypes
- The field types for thisRecordHolder
.
-
getFieldTypes
Should get the field types for thisRecordHolder
.- Returns:
- ArrayList The field types for this
RecordHolder
.
-
setRecord
Should set a singleIRecord
in the holder at index position.- Parameters:
index
- Location of Record.record
- Record to add.
-
addRecord
Should add a singleIRecord
to the end of the holder.- Parameters:
record
- Record to add.
-
addRecords
Should add a collection ofIRecord
objects to the end of the container.- Parameters:
records
- Records to add.
-
getRecord
Should get a singleIRecord
at an index.- Parameters:
index
- Location of record.- Returns:
- IRecord Record requested.
-
getRecords
Should get allIRecord
objects.- Returns:
- ArrayList All records.
-