com.screenscraper.datamanager.skeleton

Class BasicSchema

java.lang.Object

com.screenscraper.datamanager.skeleton.BasicSchema

All Implemented Interfaces:

RelationalSchema

Direct Known Subclasses:

SqlTableSchema, XmlSchema

public class BasicSchema
extends java.lang.Object
implements RelationalSchema

Object representing a unit of data storage, be it a database table, XML node, etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.Map<SchemaAttr,java.lang.String>>	columns
protected java.util.Map<java.lang.String,DataObject.ObjectType>	columnTypes Maps column names to a nested map of properties or attributes about the column.
protected java.util.Set<SchemaForeignKey>	fks
protected java.util.Set<SchemaKey>	keys
protected java.lang.String	name
protected SchemaKey	primaryKey

Constructor Summary

Constructors

Constructor and Description
BasicSchema(BasicSchema other) Copies the schema without the events
BasicSchema(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
RelationalSchema	addAttr(java.lang.String column, SchemaAttr attr, java.lang.String attrVal) Add an arbitrary attribute to the schema.
RelationalSchema	addColumn(java.lang.String column, DataObject.ObjectType type) add a column to the AbstractSchema
RelationalSchema	addColumn(java.lang.String column, DataObject.ObjectType type, java.util.Map<SchemaAttr,java.lang.String> attrs) add a column to the schema with the given attributes
RelationalSchema	addDefaultColumn(java.lang.String column)
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) manually add the foreign key relationship, this would be used to link schemas if the database engine doesn't support foreign keys.
RelationalSchema	addForeignKey(java.lang.String localColumn, java.lang.String parentSchema, java.lang.String parentColumn) manually add the foreign key relationship, this would be used to link schemas if the database engine doesn't support foreign keys.
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
java.util.Map<java.lang.String,DataObject>	convertToDataObject(java.util.Map<java.lang.String,java.lang.Object> data)
DataObject	convertToDataObject(java.lang.String column, java.lang.Object o) convert an Object to a DataObject.
boolean	equals(java.lang.Object o)
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<SchemaAttr,java.lang.String>	getDefaultAttrs()
java.util.Map<java.lang.String,DataObject>	getDefaultValues() returns a map with the default values for 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.util.Set<java.lang.String>	getForeignTables() returns all of the tables that the schema has foreign keys for
java.util.Set<SchemaKey>	getKeys()
java.lang.String	getName() returns the name of the schema, for databases this corresponds to the table name
DataObject.ObjectType	getObjectType(java.lang.String column) Returns the ObjectType corresponding to the column.
DataObject.ValueParser	getParser(java.lang.String 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
int	hashCode()
RelationalSchema	removeEventListener(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener) Removes an event listener
void	removeParser(java.lang.String column)
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
java.lang.String	toString() Prints (effectively) debug information about the this AbstractSchema.

Methods inherited from class java.lang.Object

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

Field Detail

columnTypes

protected java.util.Map<java.lang.String,DataObject.ObjectType> columnTypes

Maps column names to a nested map of properties or attributes about the column.

columns

protected java.util.Map<java.lang.String,java.util.Map<SchemaAttr,java.lang.String>> columns

keys

protected java.util.Set<SchemaKey> keys

fks

@NotNull
protected final java.util.Set<SchemaForeignKey> fks

primaryKey

protected SchemaKey primaryKey

name

protected java.lang.String name

Constructor Detail

BasicSchema

public BasicSchema(java.lang.String name)

BasicSchema

public BasicSchema(@NotNull
                   BasicSchema other)

Copies the schema without the events

Parameters:

other - The schema to copy

Method Detail

addColumn

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

add a column to the AbstractSchema

Specified by:

addColumn in interface RelationalSchema

Parameters:

column - The column to add

type - The data type of the column

Returns:

A reference to this schema

addColumn

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

add a column to the schema with the given attributes

Specified by:

addColumn in interface RelationalSchema

Parameters:

column - The column to add

type - The type of the column

attrs - Any attributes of the column

Returns:

A reference to this schema

getDefaultAttrs

public java.util.Map<SchemaAttr,java.lang.String> getDefaultAttrs()

addDefaultColumn

@NotNull
public RelationalSchema addDefaultColumn(java.lang.String column)

setObjectType

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

Description copied from interface: RelationalSchema

Sets the object type of the column.

Specified by:

setObjectType in interface RelationalSchema

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

addAttr

@NotNull
public RelationalSchema addAttr(@Nullable
                                          java.lang.String column,
                                          @Nullable
                                          SchemaAttr attr,
                                          java.lang.String attrVal)

Add an arbitrary attribute to the schema.

Specified by:

addAttr in interface RelationalSchema

Parameters:

column - The name of the column

attr - The attribute to add

attrVal - The value of the attribute

Returns:

A reference to this schema

addForeignKey

@NotNull
public RelationalSchema addForeignKey(SchemaForeignKey fk)

manually add the foreign key relationship, this would be used to link schemas if the database engine doesn't support foreign keys.

Specified by:

addForeignKey in interface RelationalSchema

Parameters:

fk - The foreign key to add

Returns:

A reference to this schema

addForeignKey

@NotNull
public RelationalSchema addForeignKey(java.lang.String localColumn,
                                                java.lang.String parentSchema,
                                                java.lang.String parentColumn)

manually add the foreign key relationship, this would be used to link schemas if the database engine doesn't support foreign keys. Using this method only 1 column mapping can be defined for the key and the name of the key is the same as the local column name

Parameters:

localColumn - The name of the column on this schema that references the parent table

parentSchema - The schema name of the parent

parentColumn - The column name on the parent schema

Returns:

The relational schema that was added

convertToDataObject

@NotNull
public java.util.Map<java.lang.String,DataObject> convertToDataObject(@NotNull
                                                                                java.util.Map<java.lang.String,java.lang.Object> data)

getForeignTables

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

returns all of the tables that the schema has foreign keys for

Returns:

Set of all the foreign key tables this schema links to

getAutoGeneratedColumns

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

Description copied from interface: RelationalSchema

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

Specified by:

getAutoGeneratedColumns in interface RelationalSchema

Returns:

A set of columns that have values that are auto generated

containsColumn

public boolean containsColumn(@NotNull
                              java.lang.String column)

Description copied from interface: RelationalSchema

returns whether the Schema contains the specified column, case insensitive

Specified by:

containsColumn in interface RelationalSchema

Parameters:

column - The column to check for

Returns:

True if the schema contains the column, false otherwise

containsAllColumns

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

Description copied from interface: RelationalSchema

returns whether the Schema contains the specified column, case insensitive

Specified by:

containsAllColumns in interface RelationalSchema

Parameters:

columns - The columns to check for

Returns:

True iff all columns given are part of this schema

getColumns

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

Description copied from interface: RelationalSchema

retrieve all the columns in the Schema

Specified by:

getColumns in interface RelationalSchema

Returns:

A set of all columns in this schema

getAttrs

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

Description copied from interface: RelationalSchema

retrieve all the attribute values for a specific column

Specified by:

getAttrs in interface RelationalSchema

Parameters:

column - The column to get information for

Returns:

A Map of attributes for the specified column

getObjectType

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

Description copied from interface: RelationalSchema

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

Specified by:

getObjectType in interface RelationalSchema

Parameters:

column - The column to get information for

Returns:

The type of the object stored in the given column

setDateFormat

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

Description copied from interface: RelationalSchema

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

Specified by:

setDateFormat in interface RelationalSchema

Parameters:

column - The column to set the format for

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

setDateFormat

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

Description copied from interface: RelationalSchema

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

Specified by:

setDateFormat in interface RelationalSchema

Parameters:

column - The column to set the format for

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

getAttr

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

Description copied from interface: RelationalSchema

retrieve an attribute value from the schema

Specified by:

getAttr in interface RelationalSchema

Parameters:

column - The column to get information for

attr - The attribute to get the value for

Returns:

The value of the attribute

getDefaultValues

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

returns a map with the default values for columns

Specified by:

getDefaultValues in interface RelationalSchema

Returns:

default values for the schema

convertToDataObject

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

Description copied from interface: RelationalSchema

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

Specified by:

convertToDataObject in interface RelationalSchema

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

public java.lang.String getName()

returns the name of the schema, for databases this corresponds to the table name

Specified by:

getName in interface RelationalSchema

Returns:

table name

toString

@NotNull
public java.lang.String toString()

Prints (effectively) debug information about the this AbstractSchema.

Overrides:

toString in class java.lang.Object

Returns:

String representation of the schema

addEventListener

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

Description copied from interface: RelationalSchema

Adds an event listener using a default priority

Specified by:

addEventListener in interface RelationalSchema

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
public DataManagerEventListener addEventListenerWithPriority(@NotNull
                                                                       DataManagerEventSource.EventFireTime when,
                                                                       @NotNull
                                                                       DataManagerEventListener listener,
                                                                       int priority)

Description copied from interface: RelationalSchema

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

Specified by:

addEventListenerWithPriority in interface RelationalSchema

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

getEventListeners

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

Description copied from interface: RelationalSchema

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

Specified by:

getEventListeners in interface RelationalSchema

Parameters:

when - The time the events fire

Returns:

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

removeEventListener

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

Description copied from interface: RelationalSchema

Removes an event listener

Specified by:

removeEventListener in interface RelationalSchema

Parameters:

when - The time the event would fire

listener - The listener to remove

Returns:

A reference to this schema

fireEvent

public void fireEvent(@NotNull
                      DataManagerEventSource.EventFireTime when,
                      @NotNull
                      DataManagerEvent evt)

Description copied from interface: RelationalSchema

Fires an event

Specified by:

fireEvent in interface RelationalSchema

Parameters:

when - The time to fire all events for

evt - The data of the event that will be fired

getKeys

@NotNull
public java.util.Set<SchemaKey> getKeys()

getForeignKeys

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

Description copied from interface: RelationalSchema

retrieve the foreign keys associated with this schema.

Specified by:

getForeignKeys in interface RelationalSchema

Returns:

[column, fkTable, fkColumn]

setPrimaryKey

@NotNull
public RelationalSchema setPrimaryKey(@NotNull
                                                SchemaKey primary)

Description copied from interface: RelationalSchema

Sets the primary key for this schema

Specified by:

setPrimaryKey in interface RelationalSchema

Parameters:

primary - The primary key for the schema

Returns:

A reference to this schema

addIndex

@NotNull
public RelationalSchema addIndex(SchemaKey key)

Description copied from interface: RelationalSchema

Set a column as a key column in the schema

Specified by:

addIndex in interface RelationalSchema

Parameters:

key - The key to add as an index

Returns:

A reference to this schema

getPrimaryKey

public SchemaKey getPrimaryKey()

Description copied from interface: RelationalSchema

retrieve the primary key associated with this schema.

Specified by:

getPrimaryKey in interface RelationalSchema

Returns:

[column, fkTable, fkColumn]

getUniqueIndexes

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

Description copied from interface: RelationalSchema

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

Specified by:

getUniqueIndexes in interface RelationalSchema

Returns:

[column, fkTable, fkColumn]

getForeignKeys

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

Description copied from interface: RelationalSchema

Retrieve the column that points to the Foreign table

Specified by:

getForeignKeys in interface RelationalSchema

Parameters:

parentTable - The name of the parent table

Returns:

The set of keys the point to the specified table

removeParser

public void removeParser(java.lang.String column)

setParser

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

Description copied from interface: RelationalSchema

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

Specified by:

setParser in interface RelationalSchema

Parameters:

column - The column to set a parser for

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

getParser

public DataObject.ValueParser getParser(java.lang.String column)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object