Repository class

Package: com.tecit.TFORMer.Repository

Opens or creates a Repository, opens a stand-alone FormLayout.

Usage and notes

Overview

A Repository is represented by a master file (extension *.tfr) and a subfolder structure on the file system. It references an arbitrary number of user-defined Project objects. These user-defined Projects are used to divide a Repository into logical areas. Each Project is a container which holds DataField definitions, DataSource definitions and references an arbitrary number of FormLayout objects.

The so-called GlobalProject is allocated by default and is used to define DataFields and DataSources which are available for all FormLayouts regardless of their actual Project membership.

Note

In contrast to a stand-alone FormLayout, the GlobalProject of a Repository can not store references to a FormLayout.

Examples

To open a stand-alone FormLayout do the following:

  // Create a new Repository instance using a stand-alone FormLayout (extension *.tff)
  // Examples are usually installed in
  // - Windows Vista or later: C:/Program Data/TEC-IT/TFORMer/9/Examples
  // - Older Microsoft Windows versions: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples
  Repository repository = new Repository("C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples/Command Line/ODBCReportPDF/ODBCReportPDF.tff", false, true);

To open a Repository do the following:

  // Create a new Repository instance using a Repository (extension *.tfr)
  // Examples are usually installed in
  // - Windows Vista: C:/Program Data/TEC-IT/TFORMer/9/Examples
  // - Older Microsoft Windows versions: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples
  Repository repository = new Repository("C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples/Demo Repository/Demos.tfr", false, true);

Note

This class writes only changes to Repository-files (extension *.tfr) to disk. A stand-alone FormLayout cannot be created, saved or permanently modified on disk via this class.

Note

Thread-safety: A single instance of this class must not be used by different threads.

Constructors

MemberDescription
Repository(String, boolean, boolean)

Constructor for Repository objects.

Methods

MemberDescription
addJobTrayControl(String)Returns: JobTrayControl

Creates and adds a new JobTrayControl to the Repository.

addPrinter(String)Returns: Printer

Creates and adds the Printer to the Repository.

addProject(String)Returns: Project

Creates and adds the Project in the Repository.

close(boolean)Returns: void

Close this Repository.

dispose()Returns: void

Releases the resources allocated by the instance.

dump(PrintStream)Returns: void

Dump the current instance into the stream.

finalize()Returns: void

Releases unmanaged resources and performs other cleanup operations before the Repository is reclaimed by garbage collection.

getBuildNumber()Returns: int

Gets the build number of the Repository.

getComment()Returns: String

Gets the comment for the Repository.

getDefaultDataSource()Returns: DataSource

Gets the default DataSource.

getDefaultJobTrayControl()Returns: JobTrayControl

Gets the default JobTrayControl in the Repository.

getDefaultPrinter()Returns: Printer

Gets the default Printer of the Repository.

getDescription()Returns: String

Gets the description of the Repository.

getFirstJobTrayControl()Returns: JobTrayControl

Gets the first JobTrayControl in the Repository.

getFirstPrinter()Returns: Printer

Gets the first Printer stored in the Repository.

getFirstProject()Returns: Project

Gets the first Project stored in the Repository.

getFullPath()Returns: String

Gets the full pathname of the Repository.

getGlobalProject()Returns: Project

Gets the global Project of the Repository.

getJobTrayControl(String)Returns: JobTrayControl

Gets a JobTrayControl defined in the Repository.

getNumberOfJobTrayControls()Returns: int

Gets the number of JobTrayControl-objects stored in the Repository.

getNumberofPrinters()Returns: int

Gets the number of Printers defined in the Repository.

getNumberOfProjects()Returns: int

Gets the number of Project-objects stored in the Repository.

getPrinter(String)Returns: Printer

Gets the Printer from the Repository.

getProject(String)Returns: Project

Gets the Project defined in the Repository.

getVersionMajor()Returns: int

Gets the major version number of the Repository.

getVersionMinor()Returns: int

Gets the minor version number of the Repository.

isAutoSave()Returns: boolean

Gets a flag indicating whether to save changes to the Repository automatically.

isModified()Returns: boolean

Gets/Sets a flag indicating whether this Repository has been modified.

isReadOnly()Returns: boolean

Gets a flag indicating whether this Repository is read-only.

removeJobTrayControl(JobTrayControl)Returns: void

Removes the JobTrayControl from the Repository.

removeJobTrayControl(String)Returns: void

Removes the JobTrayControl from the Repository.

removePrinter(Printer)Returns: void

Removes the Printer from the Repository.

removePrinter(String)Returns: void

Removes the Printer from the Repository.

removeProject(Project)Returns: void

Removes the Project from the Repository.

removeProject(String)Returns: void

Removes the Project from the Repository.

save()Returns: void

Saves this Repository.

saveAs(String)Returns: void

Saves a copy of this Repository.

setAutoSave(boolean)Returns: void

Sets a flag indicating whether to save changes to the Repository automatically.

setComment(String)Returns: void

Sets the comment for the Repository.

setDescription(String)Returns: void

Sets the description of the Repository.

setModified(boolean)Returns: void

Sets a flag indicating whether this Repository has been modified.

toString()Returns: String

Returns a string representation of the instance.

Search documentation

Search in
More scopes
Additional scopes

All contents