com.screenscraper.datamanager

Interface RelationalSchema

All Known Implementing Classes:

BasicSchema, SqlTableSchema, XmlSchema

public interface RelationalSchema

General methods available to a Schema. Most of these are implemented in the

Method Summary

Modifier and Type	Method and Description
RelationalSchema	addAttr(java.lang.String column, SchemaAttr attr, java.lang.String attrValue) add an attribute to a column
RelationalSchema	addColumn(java.lang.String column, DataObject.ObjectType type) add a column to the DataManager
RelationalSchema	addColumn(java.lang.String column, DataObject.ObjectType type, java.util.Map<SchemaAttr,java.lang.String> attrs) add a column with the attributes to the schema
DataManagerEventListener	addEventListener(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener) Adds an event listener using a default priority
DataManagerEventListener	addEventListenerWithPriority(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener, int priority) Add an event listener with a specified execution priority.
RelationalSchema	addForeignKey(SchemaForeignKey fk) Set a foreign key in the schema
RelationalSchema	addIndex(SchemaKey key) Set a column as a key column in the schema
boolean	containsAllColumns(java.util.Set<java.lang.String> columns) returns whether the Schema contains the specified column, case insensitive
boolean	containsColumn(java.lang.String column) returns whether the Schema contains the specified column, case insensitive
DataObject	convertToDataObject(java.lang.String column, java.lang.Object o) convert an Object to a DataObject.
void	fireEvent(DataManagerEventSource.EventFireTime when, DataManagerEvent evt) Fires an event
java.lang.String	getAttr(java.lang.String column, SchemaAttr attr) retrieve an attribute value from the schema
java.util.Map<SchemaAttr,java.lang.String>	getAttrs(java.lang.String column) retrieve all the attribute values for a specific column
java.util.Set<java.lang.String>	getAutoGeneratedColumns() retrieve the columns whose values are Auto-generated (don't need to be added via the DataManager.addData method)
java.util.Set<java.lang.String>	getColumns() retrieve all the columns in the Schema
java.util.Map<java.lang.String,DataObject>	getDefaultValues() retrieve a map with the default values of the columns
java.util.List<DataManagerEventListener>	getEventListeners(DataManagerEventSource.EventFireTime when) Returns all the event listeners for this schema that fire at the specified time
java.util.Set<SchemaForeignKey>	getForeignKeys() retrieve the foreign keys associated with this schema.
java.util.Set<SchemaForeignKey>	getForeignKeys(java.lang.String parentTable) Retrieve the column that points to the Foreign table
java.lang.String	getName() retrieves the name of the Schema
DataObject.ObjectType	getObjectType(java.lang.String column) Returns the ObjectType corresponding to the column.
SchemaKey	getPrimaryKey() retrieve the primary key associated with this schema.
java.util.Set<SchemaKey>	getUniqueIndexes() retrieve the non-primary key unique index's associated with the schema
RelationalSchema	removeEventListener(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener) Removes an event listener
void	setDateFormat(java.lang.String column, java.text.DateFormat dateFormat) Sets the date format used for a column to parse strings to dates
void	setDateFormat(java.lang.String column, java.time.format.DateTimeFormatter dateFormat) Sets the date format used for a column to parse strings to dates
RelationalSchema	setObjectType(java.lang.String column, DataObject.ObjectType type) Sets the object type of the column.
void	setParser(java.lang.String column, DataObject.ValueParser parser) Sets a custom parser used to parse the data for the specified column
RelationalSchema	setPrimaryKey(SchemaKey primary) Sets the primary key for this schema

Method Detail

getObjectType

DataObject.ObjectType getObjectType(java.lang.String column)

Returns the ObjectType corresponding to the column. These are java type names as opposed to database type names.

Parameters:

column - The column to get information for

Returns:

The type of the object stored in the given column

setObjectType

@NotNull
RelationalSchema setObjectType(@NotNull
                                         java.lang.String column,
                                         DataObject.ObjectType type)

Sets the object type of the column.

Parameters:

column - The column to set a type for

type - The type to set as being in the column

Returns:

A reference to this schema

getAttr

@Nullable
java.lang.String getAttr(@NotNull
                                    java.lang.String column,
                                    SchemaAttr attr)

retrieve an attribute value from the schema

Parameters:

column - The column to get information for

attr - The attribute to get the value for

Returns:

The value of the attribute

getAttrs

java.util.Map<SchemaAttr,java.lang.String> getAttrs(java.lang.String column)

retrieve all the attribute values for a specific column

Parameters:

column - The column to get information for

Returns:

A Map of attributes for the specified column

addAttr

@NotNull
RelationalSchema addAttr(java.lang.String column,
                                   SchemaAttr attr,
                                   java.lang.String attrValue)

add an attribute to a column

Parameters:

column - The column to add the attribute to

attr - The attribute to add

attrValue - The value of the attribute to add

Returns:

A reference to this schema

getColumns

@NotNull
java.util.Set<java.lang.String> getColumns()

retrieve all the columns in the Schema

Returns:

A set of all columns in this schema

addColumn

@NotNull
RelationalSchema addColumn(java.lang.String column,
                                     DataObject.ObjectType type)

add a column to the DataManager

Parameters:

column - The name of the column to add

type - The type of data stored in the column

Returns:

A reference to this schema

addColumn

@NotNull
RelationalSchema addColumn(java.lang.String column,
                                     DataObject.ObjectType type,
                                     java.util.Map<SchemaAttr,java.lang.String> attrs)

add a column with the attributes to the schema

Parameters:

column - The name of the column to add

type - The type of the data stored in the column

attrs - The attributes of the column

Returns:

A reference to this schema

convertToDataObject

@Nullable
DataObject convertToDataObject(java.lang.String column,
                                          java.lang.Object o)

convert an Object to a DataObject. A DataObject contains additional information such as type information and also contains information of how to parse values from Strings and Numbers into the Object

Parameters:

column - The column the object will be added to

o - The object given that should be converted to the type of the column

Returns:

The DataObject that contains the converted object

getName

java.lang.String getName()

retrieves the name of the Schema

Returns:

The name of the Schema

addIndex

@NotNull
RelationalSchema addIndex(SchemaKey key)

Set a column as a key column in the schema

Parameters:

key - The key to add as an index

Returns:

A reference to this schema

addForeignKey

@NotNull
RelationalSchema addForeignKey(SchemaForeignKey fk)

Set a foreign key in the schema

Parameters:

fk - The foreign key to add

Returns:

A reference to this schema

getDefaultValues

@NotNull
java.util.Map<java.lang.String,DataObject> getDefaultValues()

retrieve a map with the default values of the columns

Returns:

A map of the default values for all columns

getAutoGeneratedColumns

@NotNull
java.util.Set<java.lang.String> getAutoGeneratedColumns()

retrieve the columns whose values are Auto-generated (don't need to be added via the DataManager.addData method)

Returns:

A set of columns that have values that are auto generated

getForeignKeys

@NotNull
java.util.Set<SchemaForeignKey> getForeignKeys()

retrieve the foreign keys associated with this schema.

Returns:

[column, fkTable, fkColumn]

getPrimaryKey

SchemaKey getPrimaryKey()

retrieve the primary key associated with this schema.

Returns:

[column, fkTable, fkColumn]

getUniqueIndexes

@NotNull
java.util.Set<SchemaKey> getUniqueIndexes()

retrieve the non-primary key unique index's associated with the schema

Returns:

[column, fkTable, fkColumn]

getForeignKeys

@NotNull
java.util.Set<SchemaForeignKey> getForeignKeys(java.lang.String parentTable)

Retrieve the column that points to the Foreign table

Parameters:

parentTable - The name of the parent table

Returns:

The set of keys the point to the specified table

containsColumn

boolean containsColumn(java.lang.String column)

returns whether the Schema contains the specified column, case insensitive

Parameters:

column - The column to check for

Returns:

True if the schema contains the column, false otherwise

containsAllColumns

boolean containsAllColumns(java.util.Set<java.lang.String> columns)

returns whether the Schema contains the specified column, case insensitive

Parameters:

columns - The columns to check for

Returns:

True iff all columns given are part of this schema

addEventListener

@NotNull
DataManagerEventListener addEventListener(DataManagerEventSource.EventFireTime when,
                                                    DataManagerEventListener listener)

Adds an event listener using a default priority

Parameters:

when - The time when the event should fire

listener - The listener that will handle the event

Returns:

The listener that will handle the event

addEventListenerWithPriority

@NotNull
DataManagerEventListener addEventListenerWithPriority(DataManagerEventSource.EventFireTime when,
                                                                DataManagerEventListener listener,
                                                                int priority)

Add an event listener with a specified execution priority. Note the highest priority values (Integer.MIN_VALUE through Integer.MIN_VALUE + 100) are reserved for internal use and shouldn't be used in manual code without testing as the custom callbacks may happen before internal ones building the proper values on the node

Parameters:

when - The time when the event should fire

listener - The listener that will handle the event

priority - The priority for the event, with lower numbers being higher priority. Should be greater than Integer.MIN_VALUE + 100 (the first 100 values are reserved for internal use)

Returns:

The listener that will handle the event

Since:

7.0.9a

getEventListeners

@NotNull
java.util.List<DataManagerEventListener> getEventListeners(DataManagerEventSource.EventFireTime when)

Returns all the event listeners for this schema that fire at the specified time

Parameters:

when - The time the events fire

Returns:

A list of the listeners that will fire at the time specified

removeEventListener

@NotNull
RelationalSchema removeEventListener(DataManagerEventSource.EventFireTime when,
                                               DataManagerEventListener listener)

Removes an event listener

Parameters:

when - The time the event would fire

listener - The listener to remove

Returns:

A reference to this schema

fireEvent

void fireEvent(DataManagerEventSource.EventFireTime when,
               DataManagerEvent evt)

Fires an event

Parameters:

when - The time to fire all events for

evt - The data of the event that will be fired

setPrimaryKey

@NotNull
RelationalSchema setPrimaryKey(SchemaKey primary)

Sets the primary key for this schema

Parameters:

primary - The primary key for the schema

Returns:

A reference to this schema

setDateFormat

void setDateFormat(@NotNull
                   java.lang.String column,
                   @NotNull
                   java.text.DateFormat dateFormat)

Sets the date format used for a column to parse strings to dates

Parameters:

column - The column to set the format for

dateFormat - The date format used to convert strings to dates for this column

setDateFormat

void setDateFormat(@NotNull
                   java.lang.String column,
                   @NotNull
                   java.time.format.DateTimeFormatter dateFormat)

Sets the date format used for a column to parse strings to dates

Parameters:

column - The column to set the format for

dateFormat - The date format used to convert strings to dates for this column

setParser

void setParser(@NotNull
               java.lang.String column,
               @NotNull
               DataObject.ValueParser parser)

Sets a custom parser used to parse the data for the specified column

Parameters:

column - The column to set a parser for

parser - The parser to use for converting extracted strings to the required type