com.screenscraper.datamanager.xml

Class XmlDataManager

java.lang.Object

com.screenscraper.datamanager.skeleton.BasicDataManager

com.screenscraper.datamanager.xml.XmlDataManager

All Implemented Interfaces:

DataManager

public class XmlDataManager
extends BasicDataManager
implements DataManager

XmlDataManger is currently not fully supported

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	encoding
(package private) java.lang.String	fileName
(package private) java.lang.String	header
static java.lang.String	OUTPUT_FILE
static java.lang.String	XML_ENCODING
static java.lang.String	XML_HEADER_VALUE

Fields inherited from class com.screenscraper.datamanager.skeleton.BasicDataManager

cacher, currentCacheBlock, currentDataNodes, eventEngine, mergeable, root, rootLock, schema, updateable

Constructor Summary

Constructors

Constructor and Description
XmlDataManager(java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
void	addSchema(java.lang.String name, java.lang.String[] childValues, java.lang.String[] attributes)
void	buildSchemas() Builds the schemas from a database.
boolean	checkDataNode(java.lang.String schema) verifies that the data is ready to be inserted.
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.lang.String	getEncoding()
java.lang.String	getFileName()
java.lang.String	getHeader()
XmlDataWriter	getNewDataWriter()
boolean	importSchemas(java.lang.String file)
void	setEncoding(java.lang.String encoding)
void	setFileName(java.lang.String fileName)
void	setHeader(java.lang.String header)

Methods inherited from class com.screenscraper.datamanager.skeleton.BasicDataManager

addData, addData, addData, addDataAssertion, addDataAssertion, addEventListener, addEventListener, addEventListenerWithPriority, addSchemalessEventListener, addSchemalessEventListenerWithPriority, cacheContent, cacheContent, cacheContent, cacheContext, cacheScrapeableFile, cacheScrapeableFile, catData, catData, clearAllData, clearData, connectTree, enablePageAndContextCaching, generateUID, getCacheReaderWriter, getColumns, getCurrentDataNode, getDatabaseSchema, getNewDataNode, getRoot, getSchema, hashData, hashData, hasSchema, removeEventListener, removeSchemalessEventListener, rollback, setDatabaseSchema, setMergeEnabled, setUpdateEnabled, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.screenscraper.datamanager.DataManager

addData, addData, addData, addEventListener, addEventListenerWithPriority, clearAllData, clearData, getColumns, getCurrentDataNode, getDatabaseSchema, getNewDataNode, getRoot, getSchema, hasSchema, setDatabaseSchema

Field Detail

fileName

java.lang.String fileName

encoding

java.lang.String encoding

header

java.lang.String header

OUTPUT_FILE

public static final java.lang.String OUTPUT_FILE

See Also:

Constant Field Values

XML_ENCODING

public static final java.lang.String XML_ENCODING

See Also:

Constant Field Values

XML_HEADER_VALUE

public static final java.lang.String XML_HEADER_VALUE

See Also:

Constant Field Values

Constructor Detail

XmlDataManager

public XmlDataManager(java.lang.String filename)

Method Detail

getNewDataWriter

@NotNull
public XmlDataWriter getNewDataWriter()

Overrides:

getNewDataWriter in class BasicDataManager

addSchema

public void addSchema(java.lang.String name,
                      @Nullable
                      java.lang.String[] childValues,
                      @Nullable
                      java.lang.String[] attributes)

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

getHeader

public java.lang.String getHeader()

setHeader

public void setHeader(java.lang.String header)

close

public void close()

Description copied from interface: DataManager

close should be called when you are done with the DataManager

Specified by:

close in interface DataManager

Overrides:

close in class BasicDataManager

buildSchemas

public void buildSchemas()

Description copied from interface: DataManager

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)

Specified by:

buildSchemas in interface DataManager

Overrides:

buildSchemas in class BasicDataManager

flush

public boolean flush()

Description copied from interface: DataManager

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

Specified by:

flush in interface DataManager

Overrides:

flush in class BasicDataManager

Returns:

true if flush was successful

commit

public boolean commit(java.lang.String schema)

Description copied from class: BasicDataManager

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

Specified by:

commit in interface DataManager

Overrides:

commit in class BasicDataManager

Parameters:

schema - The name of the schema for which to commit data

Returns:

the value of checkDataNode called on the corresponding DataNode

checkDataNode

public boolean checkDataNode(java.lang.String schema)

Description copied from class: BasicDataManager

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

Specified by:

checkDataNode in interface DataManager

Overrides:

checkDataNode in class BasicDataManager

Parameters:

schema - The name of the schema for which to check the current node

Returns:

true if data meets constraints defined in the AbstractSchema

importSchemas

public boolean importSchemas(java.lang.String file)

Overrides:

importSchemas in class BasicDataManager