prajna.structure.writer

Class DataGenerator

java.lang.Object

prajna.structure.writer.DataGenerator

public class DataGenerator
extends java.lang.Object

Utility class for generating data from a SemanticAccessor and transforming it into different formats. The DataGenerator uses a SemanticAccessor to retrieve records, and a SemanticWriter to write them. It will retrieve the specified data structure from the accessor, and then send it to the writer. This transformation can be controlled, so that the same accessor can write data to different writers.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DataGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	generateData(java.lang.String query, java.lang.String dataName) Generate data based upon the query and data name
RecordAccessor	getAccessor() Get the semantic accessor used by this DataGenerator.
java.lang.String	getDefaultData() Get the default data structure used for this DataGenerator
void	initAccessor(java.io.File configFile) Initialize the translator.
void	initAccessor(java.net.URL configUrl) Initialize the translator.
java.lang.String	query(java.lang.String queryString) Generate data from the given Endeca query string, and format it into the appropriate format
java.lang.String	query(java.lang.String queryString, int maxResults) Generate data from the given query string, and format it into the appropriate format
void	setAccessor(RecordAccessor semAccessor) Set the semantic accessor used by this DataGenerator.
void	setDefaultData(java.lang.String defaultData) Set the default data structure used for this DataGenerator
void	setSemanticWriter(StructureWriter writer) Set the semantic writer used by this translator
void	setStructureType(DataStructureType structureType) Set the default structure type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataGenerator

public DataGenerator()

Method Detail

generateData

public java.lang.String generateData(java.lang.String query,
                            java.lang.String dataName)

Generate data based upon the query and data name

Parameters:

query - The query string

dataName - The name of the data to be generated. This corresponds to data elements within the configuration file

Returns:

Data generated in whatever format is appropriate.

getAccessor

public RecordAccessor getAccessor()

Get the semantic accessor used by this DataGenerator.

Returns:

the semantic accessor

getDefaultData

public java.lang.String getDefaultData()

Get the default data structure used for this DataGenerator

Returns:

the default data structure used for this DataGenerator

initAccessor

public void initAccessor(java.io.File configFile)
                  throws java.io.IOException

Initialize the translator. This method initializes the data accessor with the configuration file provided. The defaultData parameter must correspond to one of the data structures in the configuration file, but may be null.

Parameters:

configFile - Configuration file for the Endeca Data Accessor

Throws:

java.io.IOException - If the configuration file is not available

initAccessor

public void initAccessor(java.net.URL configUrl)
                  throws java.io.IOException

Initialize the translator. This method initializes the data accessor with the configuration URL provided. The defaultData parameter must correspond to one of the data structures in the configuration file, but may be null.

Parameters:

configUrl - Configuration file for the Endeca Data Accessor, specified as a URL

Throws:

java.io.IOException - If the configuration file is not available

query

public java.lang.String query(java.lang.String queryString)

Generate data from the given Endeca query string, and format it into the appropriate format

Parameters:

queryString - an Endeca format query

Returns:

a formatted string, generated from the underlying semantic writer.

query

public java.lang.String query(java.lang.String queryString,
                     int maxResults)

Generate data from the given query string, and format it into the appropriate format

Parameters:

queryString - a data query

maxResults - the maximum number of records that should be returned for the query.

Returns:

a formatted string, generated from the underlying semantic writer.

setAccessor

public void setAccessor(RecordAccessor semAccessor)

Set the semantic accessor used by this DataGenerator.

Parameters:

semAccessor - the semantic accessor

setDefaultData

public void setDefaultData(java.lang.String defaultData)

Set the default data structure used for this DataGenerator

Parameters:

defaultData - the default data structure used for this DataGenerator

setSemanticWriter

public void setSemanticWriter(StructureWriter writer)

Set the semantic writer used by this translator

Parameters:

writer - the semantic writer

setStructureType

public void setStructureType(DataStructureType structureType)

Set the default structure type. The default structure type is used when the default data is null.

Parameters:

structureType - the default structure type