TFORMer SDK - JAVA
7.0
|
Specialized DataSource for XML data. More...
Public Member Functions | |
ComputedField | addComputedField (String name) throws TFormerException |
Creates and adds a ComputedField to the DataSource. | |
DSFieldMapping | addFieldMapping (String name) throws TFormerException |
Creates and adds a DSFieldMapping to the DataSource. | |
DataSourceParameter | addParameter (String name) throws TFormerException |
Creates and adds a DataSourceParameter to the DataSource. | |
void | dispose () throws TFormerException |
Releases the resources allocated by the instance. | |
void | dump (PrintStream s) throws IOException, TFormerException |
Dumps the current instance into a text stream. | |
String | getComment () throws TFormerException |
Gets the comment for the DataSource. | |
ComputedField | getComputedField (String name) throws TFormerException |
Gets a ComputedField defined in the DataSource. | |
String | getCopyColumnName () throws TFormerException |
Gets the CopyColumnName of the DataSource. | |
String | getDescription () throws TFormerException |
Gets the description of the DataSource. | |
DSFieldMapping | getFieldMapping (String name) throws TFormerException |
Gets a DSFieldMapping defined in the DataSource. | |
String | getFilename () throws TFormerException |
Gets the filename of the XML-file. | |
ComputedField | getFirstComputedField () throws TFormerException |
Gets the first ComputedField defined in the DataSource. | |
DSFieldMapping | getFirstDSFieldMapping () throws TFormerException |
Gets the first DSFieldMapping defined in the DataSource. | |
DataSourceParameter | getFirstParameter () throws TFormerException |
Gets the first DataSourceParameter defined in the DataSource. | |
String | getName () throws TFormerException |
Gets the name of the DataSource. | |
DataSource | getNext () throws TFormerException |
Gets the next DataSource instance defined in the Project. | |
int | getNumberOfComputedFields () throws TFormerException |
Gets the number of ComputedFields defined in the DataSource. | |
int | getNumberOfFieldMappings () throws TFormerException |
Gets the number of DSFieldMappings defined in the DataSource. | |
int | getNumberOfParameters () throws TFormerException |
Gets the number of DataSourceParameters defined in the DataSource. | |
DataSourceParameter | getParameter (String name) throws TFormerException |
Gets a DataSourceParameter defined in the DataSource. | |
DataSourceType | getType () throws TFormerException |
Gets the type of the DataSource. | |
String | getXsltFilename () throws TFormerException |
Gets the filename of the XSLT file for transforming the XML file. | |
boolean | isDefault () throws TFormerException |
Gets a value indicating whether this object stores the default DataSource. | |
boolean | isHandleEscapeSequences () throws TFormerException |
Gets if escape sequences should be translated on data retrieval or not. | |
void | removeComputedField (ComputedField computedField) throws TFormerException |
Removes the ComputedField from the DataSource. | |
void | removeComputedField (String name) throws TFormerException |
Removes the ComputedField from the DataSource. | |
void | removeFieldMapping (DSFieldMapping fieldMapping) throws TFormerException |
Removes the DSFieldMapping from the DataSource. | |
void | removeFieldMapping (String name) throws TFormerException |
Removes the DSFieldMapping from the DataSource. | |
void | removeParameter (DataSourceParameter parameter) throws TFormerException |
Removes the DataSourceParameter from the DataSource. | |
void | removeParameter (String name) throws TFormerException |
Removes the DataSourceParameter from the DataSource. | |
void | setComment (String sComment) throws TFormerException |
Sets the comment for the DataSource. | |
void | setCopyColumnName (String sCopyColumnName) throws TFormerException |
Sets the CopyColumnName of the DataSource. | |
void | setDescription (String sDescription) throws TFormerException |
Sets the description of the DataSource. | |
void | setFilename (String sFile) throws TFormerException |
Sets the filename of the XML-file. | |
void | setHandleEscapeSequences (boolean bEscapeSequences) throws TFormerException |
Sets if escape sequences should be translated on data retrieval or not. | |
void | setName (String sName) throws TFormerException |
Sets the name of the DataSource. | |
void | setXsltFilename (String sFile) throws TFormerException |
Gets the filename of the XSLT file for transforming the XML file. | |
String | toString () |
Returns a string representation of the instance. |
Specialized DataSource for XML data.
// Retrieve the global Project // DataSources are defined in a Project or a global Project Project project = repository.getGlobalProject (); // Retrieve the DataSource by name // Since we know the type of the DataSource, we can cast it to DataSourceXml DataSourceXml dataSource = (DataSourceXml)project.getDataSource("XML"); // Modify some DataSource properties dataSource.setXsltFilename(""); // clear XSLT filename
ComputedField addComputedField | ( | String | name | ) | throws TFormerException [inherited] |
Creates and adds a ComputedField to the DataSource.
name | The name of the ComputedField |
DSFieldMapping addFieldMapping | ( | String | name | ) | throws TFormerException [inherited] |
Creates and adds a DSFieldMapping to the DataSource.
name | The name of the DataField for which a DSFieldMapping should be created. |
DataSourceParameter addParameter | ( | String | name | ) | throws TFormerException [inherited] |
Creates and adds a DataSourceParameter to the DataSource.
name | The name of the DataSourceParameter |
void dispose | ( | ) | throws TFormerException [inherited] |
Releases the resources allocated by the instance.
Call this method in every case (even in case of exceptions) is this instance is not required anymore.
void dump | ( | PrintStream | s | ) | throws IOException, TFormerException |
Dumps the current instance into a text stream.
s | Instance of the stream |
Reimplemented from DataSource.
String getComment | ( | ) | throws TFormerException [inherited] |
Gets the comment for the DataSource.
ComputedField getComputedField | ( | String | name | ) | throws TFormerException [inherited] |
Gets a ComputedField defined in the DataSource.
name | The name of the ComputedField |
null
String getCopyColumnName | ( | ) | throws TFormerException [inherited] |
Gets the CopyColumnName of the DataSource.
String getDescription | ( | ) | throws TFormerException [inherited] |
Gets the description of the DataSource.
DSFieldMapping getFieldMapping | ( | String | name | ) | throws TFormerException [inherited] |
Gets a DSFieldMapping defined in the DataSource.
Retrieves the DSFieldMapping for a given DataField name from the DataSource
name | The name of a DataField |
null
String getFilename | ( | ) | throws TFormerException |
Gets the filename of the XML-file.
ComputedField getFirstComputedField | ( | ) | throws TFormerException [inherited] |
Gets the first ComputedField defined in the DataSource.
null
DSFieldMapping getFirstDSFieldMapping | ( | ) | throws TFormerException [inherited] |
Gets the first DSFieldMapping defined in the DataSource.
null
DataSourceParameter getFirstParameter | ( | ) | throws TFormerException [inherited] |
Gets the first DataSourceParameter defined in the DataSource.
null
String getName | ( | ) | throws TFormerException [inherited] |
Gets the name of the DataSource.
DataSource getNext | ( | ) | throws TFormerException [inherited] |
Gets the next DataSource instance defined in the Project.
A Project stores a list of DataSource objects. To retrieve the first DataSource in the Project see Project.getFirstDataSource.
null
if there aren't other instances in the Project, otherwise a valid instance of this class (DataSourceCsv, DataSourceOdbc or DataSourceXml)int getNumberOfComputedFields | ( | ) | throws TFormerException [inherited] |
Gets the number of ComputedFields defined in the DataSource.
int getNumberOfFieldMappings | ( | ) | throws TFormerException [inherited] |
Gets the number of DSFieldMappings defined in the DataSource.
int getNumberOfParameters | ( | ) | throws TFormerException [inherited] |
Gets the number of DataSourceParameters defined in the DataSource.
DataSourceParameter getParameter | ( | String | name | ) | throws TFormerException [inherited] |
Gets a DataSourceParameter defined in the DataSource.
name | The name of the DataSourceParameter |
null
DataSourceType getType | ( | ) | throws TFormerException [inherited] |
Gets the type of the DataSource.
The DataSourceType is read-only, and is set on creation. It specifies the type of a DataSource (e.g. DataSourceOdbc, DataSourceCsv, DataSourceXml).
String getXsltFilename | ( | ) | throws TFormerException |
Gets the filename of the XSLT file for transforming the XML file.
boolean isDefault | ( | ) | throws TFormerException [inherited] |
Gets a value indicating whether this object stores the default DataSource.
true
if this DataSource is the default DataSource.boolean isHandleEscapeSequences | ( | ) | throws TFormerException [inherited] |
Gets if escape sequences should be translated on data retrieval or not.
true
if escape sequences should be translated.void removeComputedField | ( | ComputedField | computedField | ) | throws TFormerException [inherited] |
Removes the ComputedField from the DataSource.
computedField | The ComputedField |
void removeComputedField | ( | String | name | ) | throws TFormerException [inherited] |
Removes the ComputedField from the DataSource.
name | The name of the ComputedField |
void removeFieldMapping | ( | DSFieldMapping | fieldMapping | ) | throws TFormerException [inherited] |
Removes the DSFieldMapping from the DataSource.
fieldMapping | The DSFieldMapping |
void removeFieldMapping | ( | String | name | ) | throws TFormerException [inherited] |
Removes the DSFieldMapping from the DataSource.
name | The name of the DataField for which the mapping should be deleted |
void removeParameter | ( | DataSourceParameter | parameter | ) | throws TFormerException [inherited] |
Removes the DataSourceParameter from the DataSource.
parameter | The DataSourceParameter |
void removeParameter | ( | String | name | ) | throws TFormerException [inherited] |
Removes the DataSourceParameter from the DataSource.
name | The name of the DataSourceParameter |
void setComment | ( | String | sComment | ) | throws TFormerException [inherited] |
Sets the comment for the DataSource.
sComment | The comment for the DataSource |
void setCopyColumnName | ( | String | sCopyColumnName | ) | throws TFormerException [inherited] |
Sets the CopyColumnName of the DataSource.
sCopyColumnName | The CopyColumnName of the DataSource |
void setDescription | ( | String | sDescription | ) | throws TFormerException [inherited] |
Sets the description of the DataSource.
sDescription | The description of the DataSource |
void setFilename | ( | String | sFile | ) | throws TFormerException |
Sets the filename of the XML-file.
sFile | The filename of the XML-file |
void setHandleEscapeSequences | ( | boolean | bEscapeSequences | ) | throws TFormerException [inherited] |
Sets if escape sequences should be translated on data retrieval or not.
bEscapeSequences | true if escape sequences should be translated. |
void setName | ( | String | sName | ) | throws TFormerException [inherited] |
Sets the name of the DataSource.
sName | The name of the DataSource |
void setXsltFilename | ( | String | sFile | ) | throws TFormerException |
Gets the filename of the XSLT file for transforming the XML file.
sFile | The filename of the XSLT file that should be used to transform the XML file before using it as DataSource |
String toString | ( | ) | [inherited] |
Returns a string representation of the instance.
© 2006-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH |
![]() |
Generated on Tue Oct 23 2012 16:33:20 for TFORMer SDK - JAVA with doxygen 1.8.0 |