com.screenscraper.datamanager

Interface DataManager

All Known Implementing Classes:

BasicDataManager, SqlDataManager, XmlDataManager

public interface DataManager

Method Summary

Modifier and Type	Method and Description
void	addData(DataNode n) Manually add a created DataNode to the DataManager for writing.
void	addData(java.lang.String schema, java.util.Map<java.lang.String,java.lang.Object> data) Add data to to the table represented by schema.
void	addData(java.lang.String schema, java.lang.String columnName, java.lang.Object value) Add data from the session variables to the table.
DataManagerEventListener	addEventListener(java.lang.String schema, DataManagerEventSource.EventFireTime when, DataManagerEventListener listener) Add an even listener.
DataManagerEventListener	addEventListenerWithPriority(java.lang.String schema, DataManagerEventSource.EventFireTime when, DataManagerEventListener listener, int priority) Add an event listener with a specified execution priority
void	buildSchemas() Builds the schemas from a database.
boolean	checkDataNode(java.lang.String schema) verifies that the data is ready to be inserted.
void	clearAllData() clears out all the nodes of the DataManager.
void	clearData(java.lang.String schema) Clear out all the uncommitted data for the given schema
void	close() close should be called when you are done with the DataManager
boolean	commit(java.lang.String schema) commits the row of data corresponding to the schema, so the next time addData is called it will be in a new row.
boolean	flush() writes the current data to the Database and clears out all the data.
java.util.Set<java.lang.String>	getColumns(java.lang.String schema) Retrieve the columns for a given schema
DataNode	getCurrentDataNode(java.lang.String schema) retrieves the current DataNode that is in scope for the schema
DatabaseSchema	getDatabaseSchema() Retrieve Database schema, for a Relational Database this contains all the information about the tables
DataNode	getNewDataNode(java.lang.String schema) Returns a new data node from the provided schema identifier.
RootNode	getRoot() returns the root node of the DataNode tree.
RelationalSchema	getSchema(java.lang.String schema) returns a schema with the given identifier
boolean	hasSchema(java.lang.String schema) returns whether or not th
DataManager	setDatabaseSchema(DatabaseSchema s) Manually set the DatabaseSchema.

Method Detail

buildSchemas

void buildSchemas()

Builds the schemas from a database. This can take some time so if there are any tables in the database that are not required for the DataManager it is recommended to use buildSchemas(List<String> tables)

getColumns

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

Retrieve the columns for a given schema

Parameters:

schema - The schema to get columns for

Returns:

A set of the columns in the given schema

getSchema

@NotNull
RelationalSchema getSchema(java.lang.String schema)

returns a schema with the given identifier

Parameters:

schema - The name of the schema

Returns:

AbstractSchema corresponding the schema

hasSchema

boolean hasSchema(java.lang.String schema)

returns whether or not th

Parameters:

schema - The schema to check for

Returns:

True if the schema exists, false otherwise

addData

void addData(java.lang.String schema,
             java.util.Map<java.lang.String,java.lang.Object> data)

Add data to to the table represented by schema. Entries corresponding to columns defined in the schema will be added. addData can be called multiple times per row that you want to insert into the database, then when the row has all the data call commit(String schema) and the next time you call addData a new row will be started. Data is not actually written to the database until flush() is called.

Parameters:

schema - The name of the schema, or table

data - The data to add

addData

void addData(java.lang.String schema,
             java.lang.String columnName,
             java.lang.Object value)

Add data from the session variables to the table. Column name matches are case insensitive

Parameters:

schema - The name of the schema, or table

columnName - The name of the column in the database

value - The value to add

commit

boolean commit(java.lang.String schema)

commits the row of data corresponding to the schema, so the next time addData is called it will be in a new row.

Parameters:

schema - The name of the schema to commit

Returns:

the value of checkDataNode called on the corresponding DataNode

checkDataNode

@InternalOnly
boolean checkDataNode(java.lang.String schema)

verifies that the data is ready to be inserted. If false is returned the cause can be retrieved via getMessage.

Parameters:

schema - The name of the schema

Returns:

true if data meets constraints defined in the AbstractSchema

getCurrentDataNode

DataNode getCurrentDataNode(java.lang.String schema)

retrieves the current DataNode that is in scope for the schema

Parameters:

schema - The name of the schema

Returns:

current DataNode that is in scope for the schema

getNewDataNode

@NotNull
DataNode getNewDataNode(java.lang.String schema)

Returns a new data node from the provided schema identifier. This should only be used if for some reason you need manual manipulation of the DataNode or DataNode tree. In general a DataManager.addData method should be used for adding data

Parameters:

schema - The name of the schema

Returns:

The new data node or null if the schema was invalid

addData

void addData(DataNode n)

Manually add a created DataNode to the DataManager for writing. This can be used in conjunction with DataManager.getNewDataNode for instances when manual manipulation of a DataNode is required. In general a DataManager.addData method should be used for adding data.

Parameters:

n - The node to add

clearData

void clearData(java.lang.String schema)

Clear out all the uncommitted data for the given schema

Parameters:

schema - The name of the schema

clearAllData

void clearAllData()

clears out all the nodes of the DataManager. This is called by flush and generally wouldn't be requited by the user. It is available for instances where when a certain condition is met you want to clear out all the information instead of writing.

addEventListener

@NotNull
DataManagerEventListener addEventListener(java.lang.String schema,
                                                    DataManagerEventSource.EventFireTime when,
                                                    DataManagerEventListener listener)

Add an even listener. events are fired off during specific times

Parameters:

schema - The schema the event will be added for

when - The time the event should fire

listener - The listener that will handle the event

Returns:

The listener that was added

addEventListenerWithPriority

@NotNull
DataManagerEventListener addEventListenerWithPriority(java.lang.String schema,
                                                                DataManagerEventSource.EventFireTime when,
                                                                DataManagerEventListener listener,
                                                                int priority)

Add an event listener with a specified execution priority

Parameters:

schema - The schema the event will be added for

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

Returns:

The listener that was added

Since:

7.0.9a

setDatabaseSchema

@NotNull
DataManager setDatabaseSchema(DatabaseSchema s)

Manually set the DatabaseSchema. Use this for if you don't call buildSchemas for whatever reason

Parameters:

s - The schema to set

Returns:

A reference to the DataManager

getDatabaseSchema

@Nullable
DatabaseSchema getDatabaseSchema()

Retrieve Database schema, for a Relational Database this contains all the information about the tables

Returns:

The schema for the entire database this DataManager will write to

flush

boolean flush()

writes the current data to the Database and clears out all the data.

Returns:

true if write is successful, if multithreaded writes are enabled it always returns true as there is no callback function.

getRoot

@InternalOnly
RootNode getRoot()

returns the root node of the DataNode tree. This can be handed off to a DataFilter to do preprocessing before the tree is written to the database.

Returns:

RootNode of the DataNode tree

close

void close()

close should be called when you are done with the DataManager