com.screenscraper.common

Class DataRecord

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

com.screenscraper.common.DataRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class DataRecord
extends java.util.Hashtable<java.lang.Object,java.lang.Object>
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATARECORD Used to identify a data record in an extractor pattern to be used with sub-extractor patterns.
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
DataRecord()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.Object key) Returns the value currently associated with the given key
boolean	getAppliedWhitespaceTidyingOnExtraction() Returns whether or not we applied whitespace tidying when making this data record
int	getEndMatch() Gets the end location the extractor for this data record matched at.
java.lang.String	getFullMatchedString(RunningScrapeableFile scrapeableFile) Gets the matched portion of the given string.
java.lang.String	getFullMatchedString(java.lang.String extractedText) Gets the matched portion of the given string.
java.util.Iterator<java.lang.Object>	getOrderedKeysIterator() We override this so that we can avoid cryptic errors on the front-end.
int	getStartMatch() Gets the start location the extractor for this data record matched at.
int	hashCode() A hashcode for the current DataRecord, which doesn't change based on the values in the DataRecord
void	keepFields(java.util.Set<java.lang.String> fieldsToKeep) Removes fields from the data set that are not contained in the supplied set.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Puts the given key value pair in the DataRecord
java.lang.Object	remove(java.lang.Object key) Removes the specified key and associated value from the DataRecord
void	setAppliedWhitespaceTidyingOnExtraction(boolean appliedWhitespaceTidyingOnExtraction) Sets whether or not we applied whitespace tidying when making this data record
void	setEndMatch(int endMatch) Sets the end location the extractor for this data record matched at.
void	setStartMatch(int startMatch) Sets the start location the extractor for this data record matched at.

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

DATARECORD

public static final java.lang.String DATARECORD

Used to identify a data record in an extractor pattern to be used with sub-extractor patterns.

See Also:

Constant Field Values

Constructor Detail

DataRecord

public DataRecord()

Method Detail

getOrderedKeysIterator

@NotNull
public java.util.Iterator<java.lang.Object> getOrderedKeysIterator()

We override this so that we can avoid cryptic errors on the front-end.

Returns:

Iterator The iterator for the keys in the order they were put into the DataRecord.

put

@Nullable
public java.lang.Object put(@NotNull
                                       java.lang.Object key,
                                       @Nullable
                                       java.lang.Object value)

Puts the given key value pair in the DataRecord

Specified by:

put in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

put in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Parameters:

key - The key to insert

value - The value to set

Returns:

Null if the key is null, otherwise the previous value associated with the key

get

@Nullable
public java.lang.Object get(@NotNull
                                       java.lang.Object key)

Returns the value currently associated with the given key

Specified by:

get in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

get in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Parameters:

key - The key to get

Returns:

The value associated with the key in the DataRecord, or null if there is no such value (or the key is null)

remove

public java.lang.Object remove(@NotNull
                               java.lang.Object key)

Removes the specified key and associated value from the DataRecord

Specified by:

remove in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

remove in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Parameters:

key - The key to remove

Returns:

The value previously associated with the key, or null if no value was set for the given key

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.

hashCode

public int hashCode()

A hashcode for the current DataRecord, which doesn't change based on the values in the DataRecord

Specified by:

hashCode in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

hashCode in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Returns:

The hashcode for the DataRecord

getStartMatch

@InternalOnly
public int getStartMatch()

Gets the start location the extractor for this data record matched at. The location is based on the input text after it is cleared of unnecessary white space using the

Returns:

The start index of the match from the extractor that extracted this data record, or -1 if it was manually created. The location is based on the input text after it is cleared of unnecessary white space using the com.screenscraper.util.General.stripUnnecessaryWhiteSpace(String text) method.

setStartMatch

@InternalOnly
public void setStartMatch(int startMatch)

Sets the start location the extractor for this data record matched at. The location should be based on the input text after it is cleared of unnecessary white space using the @code{com.screenscraper.util.General.stripUnnecessaryWhiteSpace(String text)} method.

Parameters:

startMatch - The start location of the match

getEndMatch

@InternalOnly
public int getEndMatch()

Gets the end location the extractor for this data record matched at. The location is based on the input text after it is cleared of unnecessary white space using the

Returns:

The end index of the match from the extractor that extracted this data record, or -1 if it was manually created. The location is based on the input text after it is cleared of unnecessary white space using the com.screenscraper.util.General.stripUnnecessaryWhiteSpace(String text) method.

setEndMatch

@InternalOnly
public void setEndMatch(int endMatch)

Sets the end location the extractor for this data record matched at. The location should be based on the input text after it is cleared of unnecessary white space using the com.screenscraper.util.General.stripUnnecessaryWhiteSpace(String text) method.

Parameters:

endMatch - The end location of the match

getAppliedWhitespaceTidyingOnExtraction

@InternalOnly
public boolean getAppliedWhitespaceTidyingOnExtraction()

Returns whether or not we applied whitespace tidying when making this data record

Returns:

Whether or not we applied whitespace tidying when making this data record

setAppliedWhitespaceTidyingOnExtraction

@InternalOnly
public void setAppliedWhitespaceTidyingOnExtraction(boolean appliedWhitespaceTidyingOnExtraction)

Sets whether or not we applied whitespace tidying when making this data record

Parameters:

appliedWhitespaceTidyingOnExtraction - Whether or not we applied whitespace tidying when making this data record

getFullMatchedString

@NotNull
public java.lang.String getFullMatchedString(java.lang.String extractedText)

Gets the matched portion of the given string. This will be everything that was matched by the extractor pattern, including the section each of the tokens in the data record.

Parameters:

extractedText - The text that the data in this data record was extracted from

Returns:

The text that was matched by the extractor pattern to produce this data record

getFullMatchedString

@NotNull
 @InternalOnly
public java.lang.String getFullMatchedString(@NotNull
                                                                       RunningScrapeableFile scrapeableFile)

Gets the matched portion of the given string. This will be everything that was matched by the extractor pattern, including the section each of the tokens in the data record.

Parameters:

scrapeableFile - The scrapeableFile that the data in this data record was extracted from

Returns:

The text that was matched by the extractor pattern to produce this data record