DataSet

java.lang.Object
- com.screenscraper.common.DataSet

All Implemented Interfaces:: java.io.Serializable, java.lang.Iterable<DataRecord>

public class DataSet
extends java.lang.Object
implements java.io.Serializable, java.lang.Iterable<DataRecord>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static org.apache.log4j.Logger log
Used for logging.

Fields
Modifier and Type	Field and Description
`static org.apache.log4j.Logger`	`log` Used for logging.

Constructor Summary

Constructors
Constructor and Description
`DataSet()` An empty constructor.
`DataSet(java.util.List<DataRecord> dataRecords)` Generates a data set object, given a `List` of `DataRecord`s containing the data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDataRecord(DataRecord dataRecord)` Adds a `DataRecord`.
`void`	`addDataRecord(DataRecord dataRecord, java.util.HashSet compoundKey)` Adds a `DataRecord`.
`void`	`append(DataSet dataSet)` Appends a `DataSet` to the end of this `DataSet`, adding rows.
`void`	`append(DataSet dataSet, java.util.HashSet compoundKey)` Appends a `DataSet` to the end of this `DataSet`, adding rows.
`void`	`cache(DataSet dataSet)` Caches the data set to the database.
`void`	`clearDataRecords()` Clears all records from the set.
`void`	`closeCachedResultSet()` Closes up the cached result set.
`void`	`deleteDataRecord(int sequence)` Deletes the `DataRecord` at the given sequence.
`void`	`dropDataSetTable()` Drops the table that was used to cache this data set.
`void`	`dumpToLog()` Dumps the contents of the `DataSet` to the log.
`void`	`ensureHasBeenLoadedFromCache()` Ensures that the set has been loaded from the cache, if it was previously cached.
`void`	`filterDuplicates(java.util.HashSet compoundKey)` Filters duplicates from the data set.
`java.lang.Object`	`findValue(java.lang.String valueToFind, java.lang.String columnToMatch, java.lang.String columnToReturn)` Finds a value in a data record whose column identified by columnToMatch contains the valueToFind.
`java.lang.Object`	`get(int dataRecordNumber, java.lang.String identifier)` Gets a single item of data record.
`java.util.List<DataRecordInfo>`	`getAllDataRecordInfo()` retrieves all the DataRecordInfo containing the offsets at which the matches in the dataRecord were found.
`java.util.List<DataRecord>`	`getAllDataRecords()` Returns all of the `DataRecord` objects as an `ArrayList` of `DataRecord`s.
`java.lang.String`	`getCharacterSet()` Gets the character encoding of the content given by the server.
`DataRecord`	`getDataRecord(int dataRecordNumber)` Gets a `DataRecord` containing data extracted from a single application of an `ExtractorPattern`.
`DataRecordInfo`	`getDataRecordInfo(int i)` retrieves the DataRecordInfo in the ith position
`java.util.Iterator`	`getDataRecordIterator()` Gets an `Iterator` that can be used to cycle through all of the `DataRecord`s in the set.
`java.lang.Object`	`getFirstValueForKey(java.lang.String key)` Gets the first non-null value matching the given key.
`DataRecord`	`getNextDataRecordFromCache()` Gets the next `DataRecord` from the current result set.
`int`	`getNumDataRecords()` Returns the number of data records held by this object.
`boolean`	`hasBeenCached()` Indicates whether or not the data set has already been cached once.
`java.util.Iterator<DataRecord>`	`iterator()`
`void`	`join(DataSet dataSet)` Joins a `DataSet` to this `DataSet`, potentially adding columns.
`void`	`keepFields(java.util.Set<java.lang.String> fieldsToKeep)` Removes fields from the data set that are not contained in the supplied set.
`void`	`loadFromCache()` Re-populate the data set from the data in the cache.
`void`	`removeDataRecordFields()` Removes any fields identified by the DATARECORD constant.
`void`	`removeDATARECORDs()` Removes the DATARECORD entry, if found.
`void`	`removeField(java.lang.String field)` Removes a specific field from every data record in the set.
`void`	`setCharacterSet(java.lang.String characterSet)` Sets the character encoding of the content given by the server.
`void`	`setDataRecordInfo(java.util.List<DataRecordInfo> dataRecordInfo)` Sets the DataRecordInfo for the DataSet which contains the offsets where the text was found
`void`	`setHasBeenLoadedFromCache(boolean hasBeenLoadedFromCache)` Determines whether or not the data set has been loaded from the cache.
`int`	`size()` Same as getNumDataRecords.
`java.lang.String`	`toString()`
`void`	`writeToFile(java.lang.String fileToSaveTo)` Writes the data set to the file specified by the string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - log
```
public static org.apache.log4j.Logger log
```
    Used for logging.
- Constructor Detail
  - DataSet
```
public DataSet()
```
    An empty constructor.
  - DataSet
```
public DataSet(@NotNull
               java.util.List<DataRecord> dataRecords)
```
    Generates a data set object, given a List of DataRecords containing the data.
    
    Parameters:
    
    dataRecords - The data.
- Method Detail
  - setDataRecordInfo
```
@InternalOnly
public void setDataRecordInfo(java.util.List<DataRecordInfo> dataRecordInfo)
```
    Sets the DataRecordInfo for the DataSet which contains the offsets where the text was found
    
    Parameters:
    
    dataRecordInfo - The info to set
  - getAllDataRecordInfo
```
@InternalOnly
public java.util.List<DataRecordInfo> getAllDataRecordInfo()
```
    retrieves all the DataRecordInfo containing the offsets at which the matches in the dataRecord were found.
    
    Returns:
    
    A list of all the data record info objects
  - getDataRecordInfo
```
@InternalOnly
public DataRecordInfo getDataRecordInfo(int i)
```
    retrieves the DataRecordInfo in the ith position
    
    Parameters:
    
    i - The index (zero based) of the record info to get
    
    Returns:
    
    The specified record info, or if the index is out-of-bounds and empty record info will be returned
  - hasBeenCached
```
@InternalOnly
public boolean hasBeenCached()
```
    Indicates whether or not the data set has already been cached once.
    
    Returns:
    
    A boolean.
  - setHasBeenLoadedFromCache
```
@InternalOnly
public void setHasBeenLoadedFromCache(boolean hasBeenLoadedFromCache)
```
    Determines whether or not the data set has been loaded from the cache.
    
    Parameters:
    
    hasBeenLoadedFromCache - A boolean.
  - cache
```
@InternalOnly
public void cache(DataSet dataSet)
```
    Caches the data set to the database.
    
    Parameters:
    
    dataSet - The DataSet that should be included with this one. We write it to the database only if this isn't the first time we've cached this.
  - ensureHasBeenLoadedFromCache
```
@InternalOnly
public void ensureHasBeenLoadedFromCache()
```
    Ensures that the set has been loaded from the cache, if it was previously cached.
  - dropDataSetTable
```
@InternalOnly
public void dropDataSetTable()
```
    Drops the table that was used to cache this data set.
  - loadFromCache
```
@InternalOnly
public void loadFromCache()
```
    Re-populate the data set from the data in the cache.
  - join
```
public void join(@NotNull
                 DataSet dataSet)
```
    Joins a DataSet to this DataSet, potentially adding columns. Note that if columns with duplicate names exist between the sets the columns in the original will be overwritten.
    
    Parameters:
    
    dataSet - The DataSet to join.
  - append
```
public void append(DataSet dataSet)
```
    Appends a DataSet to the end of this DataSet, adding rows.
    
    Parameters:
    
    dataSet - The DataSet to join.
  - append
```
public void append(@Nullable
                   DataSet dataSet,
                   @Nullable
                   java.util.HashSet compoundKey)
```
    Appends a DataSet to the end of this DataSet, adding rows.
    
    Parameters:
    
    compoundKey - The column names to filter on, if records are to be filtered. If this is null records will not be filtered.
    
    dataSet - The DataSet to join.
  - addDataRecord
```
public void addDataRecord(DataRecord dataRecord)
```
    Adds a DataRecord.
    
    Parameters:
    
    dataRecord - The DataRecord to add.
  - addDataRecord
```
public void addDataRecord(DataRecord dataRecord,
                          @Nullable
                          java.util.HashSet compoundKey)
```
    Adds a DataRecord.
    
    Parameters:
    
    compoundKey - The column names to filter on, if records are to be filtered. If this is null records will not be filtered.
    
    dataRecord - The DataRecord to add.
  - filterDuplicates
```
public void filterDuplicates(@Nullable
                             java.util.HashSet compoundKey)
```
    Filters duplicates from the data set.
    
    Parameters:
    
    compoundKey - The column names to filter on, if records are to be filtered. If this is null records will not be filtered.
  - getAllDataRecords
```
@NotNull
public java.util.List<DataRecord> getAllDataRecords()
```
    Returns all of the DataRecord objects as an ArrayList of DataRecords.
    
    Returns:
    
    The data.
  - getDataRecordIterator
```
@NotNull
public java.util.Iterator getDataRecordIterator()
```
    Gets an Iterator that can be used to cycle through all of the DataRecords in the set.
    
    Returns:
    
    An Iterator.
  - getDataRecord
```
public DataRecord getDataRecord(int dataRecordNumber)
```
    Gets a DataRecord containing data extracted from a single application of an ExtractorPattern.
    
    Parameters:
    
    dataRecordNumber - The number of the data record.
    
    Returns:
    
    The data.
  - size
```
public int size()
```
    Same as getNumDataRecords.
    
    Returns:
    
    The number of DataRecords in the DataSet
  - getNumDataRecords
```
public int getNumDataRecords()
```
    Returns the number of data records held by this object.
    
    Returns:
    
    The number of data records.
  - clearDataRecords
```
public void clearDataRecords()
```
    Clears all records from the set.
  - get
```
@Nullable
public java.lang.Object get(int dataRecordNumber,
                                       @NotNull
                                       java.lang.String identifier)
```
    Gets a single item of data record.
    
    Parameters:
    
    dataRecordNumber - The number of the data record to get the datum from.
    
    identifier - The String used to identify the item of data.
    
    Returns:
    
    The datum.
  - removeDataRecordFields
```
public void removeDataRecordFields()
```
    Removes any fields identified by the DATARECORD constant.
  - dumpToLog
```
public void dumpToLog()
```
    Dumps the contents of the DataSet to the log.
  - deleteDataRecord
```
public void deleteDataRecord(int sequence)
```
    Deletes the DataRecord at the given sequence.
    
    Parameters:
    
    sequence - The sequence.
  - writeToFile
```
public void writeToFile(@Nullable
                        java.lang.String fileToSaveTo)
                 throws java.io.IOException
```
    Writes the data set to the file specified by the string.
    
    Parameters:
    
    fileToSaveTo - The file to save to.
    
    Throws:
    
    java.io.IOException - On write error
  - removeDATARECORDs
```
public void removeDATARECORDs()
```
    Removes the DATARECORD entry, if found.
  - getCharacterSet
```
@Nullable
public java.lang.String getCharacterSet()
```
    Gets the character encoding of the content given by the server.
    
    Returns:
    
    The character encoding.
  - setCharacterSet
```
public void setCharacterSet(java.lang.String characterSet)
```
    Sets the character encoding of the content given by the server.
    
    Parameters:
    
    characterSet - The character encoding.
  - closeCachedResultSet
```
public void closeCachedResultSet()
```
    Closes up the cached result set.
  - getNextDataRecordFromCache
```
@Nullable
public DataRecord getNextDataRecordFromCache()
```
    Gets the next DataRecord from the current result set.
    
    Returns:
    
    A DataRecord.
  - findValue
```
@Nullable
public java.lang.Object findValue(@NotNull
                                             java.lang.String valueToFind,
                                             @NotNull
                                             java.lang.String columnToMatch,
                                             @NotNull
                                             java.lang.String columnToReturn)
```
    Finds a value in a data record whose column identified by columnToMatch contains the valueToFind. Once found, the value in the columnToReturn column is returned.
    
    Parameters:
    
    valueToFind - The value to look for.
    
    columnToMatch - The column that may contain the valueToFind.
    
    columnToReturn - The column containing the value to return.
    
    Returns:
    
    The value in columnToReturn for the DataRecord in the set that contains valueToFind for it's columnToMatch field
  - getFirstValueForKey
```
@Nullable
public java.lang.Object getFirstValueForKey(@NotNull
                                                       java.lang.String key)
```
    Gets the first non-null value matching the given key.
    
    Parameters:
    
    key - The key to search for.
    
    Returns:
    
    A value corresponding to the key, if one was found; null, otherwise.
  - removeField
```
public void removeField(@NotNull
                        java.lang.String field)
```
    Removes a specific field from every data record in the set.
    
    Parameters:
    
    field - The name of the field to be removed.
  - keepFields
```
public void keepFields(@NotNull
                       java.util.Set<java.lang.String> fieldsToKeep)
```
    Removes fields from the data set that are not contained in the supplied set.
    
    Parameters:
    
    fieldsToKeep - A Set of field identifiers.
  - toString
```
@NotNull
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
@NotNull
public java.util.Iterator<DataRecord> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<DataRecord>

Class DataSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

log

Constructor Detail

DataSet

DataSet

Method Detail

setDataRecordInfo

getAllDataRecordInfo

getDataRecordInfo

hasBeenCached

setHasBeenLoadedFromCache

cache

ensureHasBeenLoadedFromCache

dropDataSetTable

loadFromCache

join

append

append

addDataRecord

addDataRecord

filterDuplicates

getAllDataRecords

getDataRecordIterator

getDataRecord

size

getNumDataRecords

clearDataRecords

get

removeDataRecordFields

dumpToLog

deleteDataRecord

writeToFile

removeDATARECORDs

getCharacterSet

setCharacterSet

closeCachedResultSet

getNextDataRecordFromCache

findValue

getFirstValueForKey

removeField

keepFields

toString

iterator