TFORMer SDK - JAVA
7.0
|
Provides access to Project information of a Repository or a stand-alone link FormLayout. More...
Public Member Functions | |
DataField | addDataField (String sName) throws TFormerException |
Creates and adds a DataField to the Project. | |
DataSource | addDataSource (DataSourceType type, String name) throws TFormerException |
Creates and adds a DataSource to the Project. | |
FormLayout | addFormLayout (String sName) throws TFormerException |
Creates and adds a FormLayout to the Project. | |
void | dispose () throws TFormerException |
Releases the resources allocated by this 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 Project. | |
DataField | getDataField (String name) throws TFormerException |
Gets the DataField information from the Project. | |
DataSource | getDataSource (String name) throws TFormerException |
Gets the DataSource information from the Project. | |
String | getDefaultDirectory () throws TFormerException |
Gets the default directory of the Project. | |
String | getDescription () throws TFormerException |
Gets the description of the Project. | |
DataField | getFirstDataField () throws TFormerException |
Gets the first DataField of the Project. | |
DataSource | getFirstDataSource () throws TFormerException |
Gets the first DataSource defined in the Project. | |
FormLayout | getFirstFormLayout () throws TFormerException |
Gets the first FormLayout of the Project. | |
FormLayout | getFormLayout (String sName) throws TFormerException |
Gets the FormLayout information from the Project. | |
String | getName () throws TFormerException |
Gets the name of the Project. | |
Project | getNext () throws TFormerException |
Gets the next Project defined in the Repository. | |
int | getNumberOfDataFields () throws TFormerException |
Gets the number of DataFields defined in the Project. | |
int | getNumberOfDataSources () throws TFormerException |
Gets the number of DataSources defined in the Project. | |
int | getNumberOfFormLayouts () throws TFormerException |
Gets the number of FormLayouts defined in this Project. | |
Repository | getRepository () |
Return the repository in which the project is defined. | |
void | removeDataField (DataField field) throws TFormerException |
Removes a DataField from the Project. | |
void | removeDataField (String name) throws TFormerException |
Removes a DataField from the Project. | |
void | removeDataSource (DataSource dataSource) throws TFormerException |
Removes the DataSource from the Project. | |
void | removeDataSource (String name) throws TFormerException |
Removes the DataSource from the Project. | |
void | removeFormLayout (FormLayout form) throws TFormerException |
Removes a FormLayout from the Project. | |
void | removeFormLayout (String name) throws TFormerException |
Removes a FormLayout from the Project. | |
void | setComment (String sComment) throws TFormerException |
Sets the comment for the Project. | |
void | setDescription (String sDescription) throws TFormerException |
Sets the description of the Project. | |
void | setName (String sName) throws TFormerException |
Sets the name of the Project. | |
String | toString () |
Returns a string representation of the instance. |
Provides access to Project information of a Repository or a stand-alone link FormLayout.
This class is used to retrieve or set information belonging to a user-defined Project or to the GlobalProject.
// Retrieve the first Project Project project = repository.getFirstProject (); while (project != null) { System.out.println (project.toString()); // Get the next Project project = project.getNext (); }
DataField addDataField | ( | String | sName | ) | throws TFormerException |
DataSource addDataSource | ( | DataSourceType | type, |
String | name | ||
) | throws TFormerException |
Creates and adds a DataSource to the Project.
type | The type of the DataSource |
name | The name of the DataSource to be added to the Project |
FormLayout addFormLayout | ( | String | sName | ) | throws TFormerException |
Creates and adds a FormLayout to the Project.
sName | The name of the FormLayout to be added to the Project |
void dispose | ( | ) | throws TFormerException |
Releases the resources allocated by this 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 |
String getComment | ( | ) | throws TFormerException |
DataField getDataField | ( | String | name | ) | throws TFormerException |
DataSource getDataSource | ( | String | name | ) | throws TFormerException |
Gets the DataSource information from the Project.
name | The name of the DataSource to be retrieved from the Project |
null
String getDefaultDirectory | ( | ) | throws TFormerException |
String getDescription | ( | ) | throws TFormerException |
DataField getFirstDataField | ( | ) | throws TFormerException |
DataSource getFirstDataSource | ( | ) | throws TFormerException |
Gets the first DataSource defined in the Project.
FormLayout getFirstFormLayout | ( | ) | throws TFormerException |
Gets the first FormLayout of the Project.
null
if no FormLayout existsFormLayout getFormLayout | ( | String | sName | ) | throws TFormerException |
Gets the FormLayout information from the Project.
sName | The name of the FormLayout to be retrieved from the Project |
null
String getName | ( | ) | throws TFormerException |
Project getNext | ( | ) | throws TFormerException |
Gets the next Project defined in the Repository.
A Repository stores a list of Project objects. You can use this method to iterate through the list. To retrieve the first Project in the Repository see Repository.getFirstProject.
null
int getNumberOfDataFields | ( | ) | throws TFormerException |
int getNumberOfDataSources | ( | ) | throws TFormerException |
Gets the number of DataSources defined in the Project.
int getNumberOfFormLayouts | ( | ) | throws TFormerException |
Gets the number of FormLayouts defined in this Project.
Return the repository in which the project is defined.
void removeDataField | ( | DataField | field | ) | throws TFormerException |
void removeDataField | ( | String | name | ) | throws TFormerException |
void removeDataSource | ( | DataSource | dataSource | ) | throws TFormerException |
Removes the DataSource from the Project.
dataSource | The DataSource to be removed from the Project |
void removeDataSource | ( | String | name | ) | throws TFormerException |
Removes the DataSource from the Project.
name | The name of the DataSource to be removed from the Project |
void removeFormLayout | ( | FormLayout | form | ) | throws TFormerException |
void removeFormLayout | ( | String | name | ) | throws TFormerException |
Removes a FormLayout from the Project.
name | Name of the FormLayout to be removed |
void setComment | ( | String | sComment | ) | throws TFormerException |
void setDescription | ( | String | sDescription | ) | throws TFormerException |
void setName | ( | String | sName | ) | throws TFormerException |
String toString | ( | ) |
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 |