org.pentaho.di.repository
Interface Repository

All Known Implementing Classes:
KettleDatabaseRepository, KettleFileRepository

public interface Repository


Method Summary
 void clearSharedObjectCache()
          Clear the shared object cache, if applicable.
 void connect(String username, String password)
          Connect to the repository.
 int countNrJobEntryAttributes(ObjectId id_jobentry, String code)
           
 int countNrStepAttributes(ObjectId id_step, String code)
           
 RepositoryDirectoryInterface createRepositoryDirectory(RepositoryDirectoryInterface parentDirectory, String directoryPath)
          Create a new directory, possibly by creating several sub-directies of / at the same time.
 void deleteClusterSchema(ObjectId id_cluster)
           
 void deleteDatabaseMeta(String databaseName)
          Remove a database connection from the repository
 void deleteJob(ObjectId id_job)
           
 void deletePartitionSchema(ObjectId id_partition_schema)
           
 void deleteRepositoryDirectory(RepositoryDirectoryInterface dir)
           
 void deleteSlave(ObjectId id_slave)
           
 void deleteTransformation(ObjectId id_transformation)
          Delete everything related to a transformation from the repository.
 void disconnect()
          Disconnect from the repository.
 boolean exists(String name, RepositoryDirectoryInterface repositoryDirectory, RepositoryObjectType objectType)
          See if a repository object exists in the repository
 RepositoryDirectoryInterface findDirectory(ObjectId directory)
           
 RepositoryDirectoryInterface findDirectory(String directory)
           
 ObjectId getClusterID(String name)
           
 ObjectId[] getClusterIDs(boolean includeDeleted)
           
 String[] getClusterNames(boolean includeDeleted)
           
 String getConnectMessage()
          This is an informational message that a repository can display on connecting within Spoon.
 ObjectId getDatabaseID(String name)
           
 ObjectId[] getDatabaseIDs(boolean includeDeleted)
           
 String[] getDatabaseNames(boolean includeDeleted)
           
 RepositoryDirectoryInterface getDefaultSaveDirectory(RepositoryElementInterface repositoryElement)
           
 String[] getDirectoryNames(ObjectId id_directory)
          Returns the child directory names of a parent directory
 IRepositoryExporter getExporter()
           
 IRepositoryImporter getImporter()
           
 List<RepositoryElementMetaInterface> getJobAndTransformationObjects(ObjectId id_directory, boolean includeDeleted)
          Gets all job and transformation objects in the given directory.
 boolean getJobEntryAttributeBoolean(ObjectId id_jobentry, int nr, String code)
           
 boolean getJobEntryAttributeBoolean(ObjectId id_jobentry, String code)
           
 boolean getJobEntryAttributeBoolean(ObjectId id_jobentry, String code, boolean def)
           
 long getJobEntryAttributeInteger(ObjectId id_jobentry, int nr, String code)
           
 long getJobEntryAttributeInteger(ObjectId id_jobentry, String code)
           
 String getJobEntryAttributeString(ObjectId id_jobentry, int nr, String code)
           
 String getJobEntryAttributeString(ObjectId id_jobentry, String code)
           
 ObjectId getJobId(String name, RepositoryDirectoryInterface repositoryDirectory)
           
 String[] getJobNames(ObjectId id_directory, boolean includeDeleted)
           
 List<RepositoryElementMetaInterface> getJobObjects(ObjectId id_directory, boolean includeDeleted)
           
 String[] getJobsUsingDatabase(ObjectId id_database)
          Get the repository version.
 LogChannelInterface getLog()
           
 String getName()
           
 RepositoryObject getObjectInformation(ObjectId objectId, RepositoryObjectType objectType)
          Get more information about a certain object ID in the form of the RepositoryObject
 ObjectId getPartitionSchemaID(String name)
           
 ObjectId[] getPartitionSchemaIDs(boolean includeDeleted)
           
 String[] getPartitionSchemaNames(boolean includeDeleted)
           
 RepositoryMeta getRepositoryMeta()
           
 RepositorySecurityManager getSecurityManager()
           
 RepositorySecurityProvider getSecurityProvider()
           
 IRepositoryService getService(Class<? extends IRepositoryService> clazz)
          Retrieves a given repository service
 List<Class<? extends IRepositoryService>> getServiceInterfaces()
          Retrieves the current list of of IRepository Services.
 ObjectId getSlaveID(String name)
           
 ObjectId[] getSlaveIDs(boolean includeDeleted)
           
 String[] getSlaveNames(boolean includeDeleted)
           
 List<SlaveServer> getSlaveServers()
           
 boolean getStepAttributeBoolean(ObjectId id_step, int nr, String code)
           
 boolean getStepAttributeBoolean(ObjectId id_step, int nr, String code, boolean def)
           
 boolean getStepAttributeBoolean(ObjectId id_step, String code)
           
 long getStepAttributeInteger(ObjectId id_step, int nr, String code)
           
 long getStepAttributeInteger(ObjectId id_step, String code)
           
 String getStepAttributeString(ObjectId id_step, int nr, String code)
           
 String getStepAttributeString(ObjectId id_step, String code)
           
 ObjectId getTransformationID(String name, RepositoryDirectoryInterface repositoryDirectory)
           
 String[] getTransformationNames(ObjectId id_directory, boolean includeDeleted)
           
 List<RepositoryElementMetaInterface> getTransformationObjects(ObjectId id_directory, boolean includeDeleted)
           
 String[] getTransformationsUsingDatabase(ObjectId id_database)
           
 RepositoryDirectoryInterface getUserHomeDirectory()
           
 IUser getUserInfo()
           
 String getVersion()
          Get the repository version.
 boolean hasService(Class<? extends IRepositoryService> clazz)
          Checks whether a given repository service is available or not
 void init(RepositoryMeta repositoryMeta)
          Initialize the repository with the repository metadata and user information.
 void insertJobEntryDatabase(ObjectId id_job, ObjectId id_jobentry, ObjectId id_database)
           
 ObjectId insertLogEntry(String description)
          Insert an entry in the audit trail of the repository.
 void insertStepDatabase(ObjectId id_transformation, ObjectId id_step, ObjectId id_database)
           
 boolean isConnected()
           
 ClusterSchema loadClusterSchema(ObjectId id_cluster_schema, List<SlaveServer> slaveServers, String versionLabel)
           
 Condition loadConditionFromStepAttribute(ObjectId id_step, String code)
          Load a condition from the repository with the Object ID stored in a step attribute.
 DatabaseMeta loadDatabaseMeta(ObjectId id_database, String revision)
          Load the Database connection Metadata from the repository
 DatabaseMeta loadDatabaseMetaFromJobEntryAttribute(ObjectId id_jobentry, String nameCode, int nr, String idCode, List<DatabaseMeta> databases)
          This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
 DatabaseMeta loadDatabaseMetaFromJobEntryAttribute(ObjectId id_jobentry, String nameCode, String idCode, List<DatabaseMeta> databases)
          This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.
 DatabaseMeta loadDatabaseMetaFromStepAttribute(ObjectId id_step, String code, List<DatabaseMeta> databases)
          This method is introduced to avoid having to go over an integer/string/whatever in the interface and the step code.
 JobMeta loadJob(ObjectId id_job, String versionLabel)
          Load a job from the repository by id
 JobMeta loadJob(String jobname, RepositoryDirectoryInterface repdir, ProgressMonitorListener monitor, String revision)
          Load a job from the repository
 PartitionSchema loadPartitionSchema(ObjectId id_partition_schema, String versionLabel)
           
 RepositoryDirectoryInterface loadRepositoryDirectoryTree()
           
 SlaveServer loadSlaveServer(ObjectId id_slave_server, String versionLabel)
           
 TransMeta loadTransformation(ObjectId id_transformation, String versionLabel)
          Load a transformation by id
 TransMeta loadTransformation(String transname, RepositoryDirectoryInterface repdir, ProgressMonitorListener monitor, boolean setInternalVariables, String revision)
          Load a transformation with a name from a folder in the repository
 List<DatabaseMeta> readDatabases()
          Read all the databases defined in the repository
 SharedObjects readJobMetaSharedObjects(JobMeta jobMeta)
           
 SharedObjects readTransSharedObjects(TransMeta transMeta)
           
 ObjectId renameJob(ObjectId id_job, RepositoryDirectoryInterface newDirectory, String newName)
          Move / rename a job
 ObjectId renameRepositoryDirectory(ObjectId id, RepositoryDirectoryInterface newParentDir, String newName)
          Move / rename a repository directory
 ObjectId renameTransformation(ObjectId id_transformation, RepositoryDirectoryInterface newDirectory, String newName)
          Move / rename a transformation
 void save(RepositoryElementInterface repositoryElement, String versionComment, ProgressMonitorListener monitor)
           
 void save(RepositoryElementInterface repositoryElement, String versionComment, ProgressMonitorListener monitor, boolean overwrite)
          Save an object to the repository optionally overwriting any associated objects.
 void saveConditionStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, Condition condition)
          This method saves the object ID of the condition object (if not null) in the step attributes
 void saveDatabaseMetaJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String nameCode, String idCode, DatabaseMeta database)
          This method saves the object ID of the database object (if not null) in the job entry attributes
 void saveDatabaseMetaJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, String nameCode, String idCode, DatabaseMeta database)
          This method saves the object ID of the database object (if not null) in the job entry attributes
 void saveDatabaseMetaStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, DatabaseMeta database)
          This method saves the object ID of the database object (if not null) in the step attributes
 void saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String code, boolean value)
           
 void saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String code, long value)
           
 void saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, int nr, String code, String value)
           
 void saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, String code, boolean value)
           
 void saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, String code, long value)
           
 void saveJobEntryAttribute(ObjectId id_job, ObjectId id_jobentry, String code, String value)
           
 void saveRepositoryDirectory(RepositoryDirectoryInterface dir)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, boolean value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, double value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, long value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, int nr, String code, String value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, boolean value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, double value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, long value)
           
 void saveStepAttribute(ObjectId id_transformation, ObjectId id_step, String code, String value)
           
 void undeleteObject(RepositoryElementMetaInterface repositoryObject)
          Removes he deleted flag from a repository element in the repository.
 

Method Detail

getName

String getName()
Returns:
The name of the repository

getVersion

String getVersion()
Get the repository version.

Returns:
The repository version as a string

getRepositoryMeta

RepositoryMeta getRepositoryMeta()
Returns:
the metadata describing this repository.

getUserInfo

IUser getUserInfo()
Returns:
the currently logged on user. (also available through the repository security provider)

getSecurityProvider

RepositorySecurityProvider getSecurityProvider()
Returns:
The security provider for this repository.

getSecurityManager

RepositorySecurityManager getSecurityManager()
Returns:
The security manager for this repository.

getLog

LogChannelInterface getLog()
Returns:
the logging channel of this repository

connect

void connect(String username,
             String password)
             throws KettleException,
                    KettleSecurityException
Connect to the repository. Make sure you don't connect more than once to the same repository with this repository object.

Parameters:
username - the username of the user connecting to the repository.
password - the password of the user connecting to the repository.
Throws:
KettleSecurityException - in case the supplied user or password is incorrect.
KettleException - in case there is a general unexpected error OR if we're already connected to the repository.

disconnect

void disconnect()
Disconnect from the repository.


isConnected

boolean isConnected()

init

void init(RepositoryMeta repositoryMeta)
Initialize the repository with the repository metadata and user information.


exists

boolean exists(String name,
               RepositoryDirectoryInterface repositoryDirectory,
               RepositoryObjectType objectType)
               throws KettleException
See if a repository object exists in the repository

Parameters:
name - the name of the object
repositoryDirectory - the directory in which it should reside
objectType - the type of repository object
Returns:
true if the job exists
Throws:
KettleException - in case something goes wrong.

getTransformationID

ObjectId getTransformationID(String name,
                             RepositoryDirectoryInterface repositoryDirectory)
                             throws KettleException
Throws:
KettleException

getJobId

ObjectId getJobId(String name,
                  RepositoryDirectoryInterface repositoryDirectory)
                  throws KettleException
Throws:
KettleException

save

void save(RepositoryElementInterface repositoryElement,
          String versionComment,
          ProgressMonitorListener monitor)
          throws KettleException
Throws:
KettleException

save

void save(RepositoryElementInterface repositoryElement,
          String versionComment,
          ProgressMonitorListener monitor,
          boolean overwrite)
          throws KettleException
Save an object to the repository optionally overwriting any associated objects.

Parameters:
repositoryElement - Object to save
versionComment - Version comment for update
monitor - Progress Monitor to report feedback to
overwrite - Overwrite any existing objects involved in saving repositoryElement, e.g. repositoryElement, database connections, slave servers
Throws:
KettleException - Error saving the object to the repository

getDefaultSaveDirectory

RepositoryDirectoryInterface getDefaultSaveDirectory(RepositoryElementInterface repositoryElement)
                                                     throws KettleException
Throws:
KettleException

getUserHomeDirectory

RepositoryDirectoryInterface getUserHomeDirectory()
                                                  throws KettleException
Throws:
KettleException

clearSharedObjectCache

void clearSharedObjectCache()
Clear the shared object cache, if applicable.


loadTransformation

TransMeta loadTransformation(String transname,
                             RepositoryDirectoryInterface repdir,
                             ProgressMonitorListener monitor,
                             boolean setInternalVariables,
                             String revision)
                             throws KettleException
Load a transformation with a name from a folder in the repository

Parameters:
transname - the name of the transformation to load
The - folder to load it from
monitor - the progress monitor to use (UI feedback)
setInternalVariables - set to true if you want to automatically set the internal variables of the loaded transformation. (true is the default with very few exceptions!)
revision - the revision to load. Specify null to load the last version.
Throws:
KettleException

loadTransformation

TransMeta loadTransformation(ObjectId id_transformation,
                             String versionLabel)
                             throws KettleException
Load a transformation by id

Parameters:
id_transformation - the id of the transformation to load
versionLabel - version to load. Specify null to load the last version.
Throws:
KettleException

readTransSharedObjects

SharedObjects readTransSharedObjects(TransMeta transMeta)
                                     throws KettleException
Throws:
KettleException

renameTransformation

ObjectId renameTransformation(ObjectId id_transformation,
                              RepositoryDirectoryInterface newDirectory,
                              String newName)
                              throws KettleException
Move / rename a transformation

Parameters:
id_transformation - The ObjectId of the transformation to move
newDirectory - The RepositoryDirectoryInterface that will be the new parent of the transformation (May be null if a move is not desired)
newName - The new name of the transformation (May be null if a rename is not desired)
Returns:
The ObjectId of the transformation that was moved
Throws:
KettleException

deleteTransformation

void deleteTransformation(ObjectId id_transformation)
                          throws KettleException
Delete everything related to a transformation from the repository. This does not included shared objects : databases, slave servers, cluster and partition schema.

Parameters:
id_transformation - the transformation id to delete
Throws:
KettleException

loadJob

JobMeta loadJob(String jobname,
                RepositoryDirectoryInterface repdir,
                ProgressMonitorListener monitor,
                String revision)
                throws KettleException
Load a job from the repository

Parameters:
jobname - the name
repdir - the directory
monitor - the progress monitor or null
revision - the revision to load. Specify null to load the last version.
Throws:
KettleException

loadJob

JobMeta loadJob(ObjectId id_job,
                String versionLabel)
                throws KettleException
Load a job from the repository by id

Parameters:
id_job - the id of the job
versionLabel - version to load. Specify null to load the last version.
Throws:
KettleException

readJobMetaSharedObjects

SharedObjects readJobMetaSharedObjects(JobMeta jobMeta)
                                       throws KettleException
Throws:
KettleException

renameJob

ObjectId renameJob(ObjectId id_job,
                   RepositoryDirectoryInterface newDirectory,
                   String newName)
                   throws KettleException
Move / rename a job

Parameters:
id_job - The ObjectId of the job to move
newDirectory - The RepositoryDirectoryInterface that will be the new parent of the job (May be null if a move is not desired)
newName - The new name of the job (May be null if a rename is not desired)
Returns:
The ObjectId of the job that was moved
Throws:
KettleException

deleteJob

void deleteJob(ObjectId id_job)
               throws KettleException
Throws:
KettleException

loadDatabaseMeta

DatabaseMeta loadDatabaseMeta(ObjectId id_database,
                              String revision)
                              throws KettleException
Load the Database connection Metadata from the repository

Parameters:
id_database - the id of the database connection to load
revision - the revision to load. Specify null to load the last version.
Throws:
KettleException - in case something goes wrong with database, connection, etc.

deleteDatabaseMeta

void deleteDatabaseMeta(String databaseName)
                        throws KettleException
Remove a database connection from the repository

Parameters:
databaseName - The name of the connection to remove
Throws:
KettleException - In case something went wrong: database error, insufficient permissions, depending objects, etc.

getDatabaseIDs

ObjectId[] getDatabaseIDs(boolean includeDeleted)
                          throws KettleException
Throws:
KettleException

getDatabaseNames

String[] getDatabaseNames(boolean includeDeleted)
                          throws KettleException
Throws:
KettleException

readDatabases

List<DatabaseMeta> readDatabases()
                                 throws KettleException
Read all the databases defined in the repository

Returns:
a list of all the databases defined in the repository
Throws:
KettleException

getDatabaseID

ObjectId getDatabaseID(String name)
                       throws KettleException
Throws:
KettleException

loadClusterSchema

ClusterSchema loadClusterSchema(ObjectId id_cluster_schema,
                                List<SlaveServer> slaveServers,
                                String versionLabel)
                                throws KettleException
Throws:
KettleException

getClusterIDs

ObjectId[] getClusterIDs(boolean includeDeleted)
                         throws KettleException
Throws:
KettleException

getClusterNames

String[] getClusterNames(boolean includeDeleted)
                         throws KettleException
Throws:
KettleException

getClusterID

ObjectId getClusterID(String name)
                      throws KettleException
Throws:
KettleException

deleteClusterSchema

void deleteClusterSchema(ObjectId id_cluster)
                         throws KettleException
Throws:
KettleException

loadSlaveServer

SlaveServer loadSlaveServer(ObjectId id_slave_server,
                            String versionLabel)
                            throws KettleException
Throws:
KettleException

getSlaveIDs

ObjectId[] getSlaveIDs(boolean includeDeleted)
                       throws KettleException
Throws:
KettleException

getSlaveNames

String[] getSlaveNames(boolean includeDeleted)
                       throws KettleException
Throws:
KettleException

getSlaveServers

List<SlaveServer> getSlaveServers()
                                  throws KettleException
Returns:
a list of all the slave servers in the repository.
Throws:
KettleException

getSlaveID

ObjectId getSlaveID(String name)
                    throws KettleException
Throws:
KettleException

deleteSlave

void deleteSlave(ObjectId id_slave)
                 throws KettleException
Throws:
KettleException

loadPartitionSchema

PartitionSchema loadPartitionSchema(ObjectId id_partition_schema,
                                    String versionLabel)
                                    throws KettleException
Throws:
KettleException

getPartitionSchemaIDs

ObjectId[] getPartitionSchemaIDs(boolean includeDeleted)
                                 throws KettleException
Throws:
KettleException

getPartitionSchemaNames

String[] getPartitionSchemaNames(boolean includeDeleted)
                                 throws KettleException
Throws:
KettleException

getPartitionSchemaID

ObjectId getPartitionSchemaID(String name)
                              throws KettleException
Throws:
KettleException

deletePartitionSchema

void deletePartitionSchema(ObjectId id_partition_schema)
                           throws KettleException
Throws:
KettleException

loadRepositoryDirectoryTree

RepositoryDirectoryInterface loadRepositoryDirectoryTree()
                                                         throws KettleException
Throws:
KettleException

findDirectory

RepositoryDirectoryInterface findDirectory(String directory)
                                           throws KettleException
Throws:
KettleException

findDirectory

RepositoryDirectoryInterface findDirectory(ObjectId directory)
                                           throws KettleException
Throws:
KettleException

saveRepositoryDirectory

void saveRepositoryDirectory(RepositoryDirectoryInterface dir)
                             throws KettleException
Throws:
KettleException

deleteRepositoryDirectory

void deleteRepositoryDirectory(RepositoryDirectoryInterface dir)
                               throws KettleException
Throws:
KettleException

renameRepositoryDirectory

ObjectId renameRepositoryDirectory(ObjectId id,
                                   RepositoryDirectoryInterface newParentDir,
                                   String newName)
                                   throws KettleException
Move / rename a repository directory

Parameters:
id - The ObjectId of the repository directory to move
newParentDir - The RepositoryDirectoryInterface that will be the new parent of the repository directory (May be null if a move is not desired)
newName - The new name of the repository directory (May be null if a rename is not desired)
Returns:
The ObjectId of the repository directory that was moved
Throws:
KettleException

createRepositoryDirectory

RepositoryDirectoryInterface createRepositoryDirectory(RepositoryDirectoryInterface parentDirectory,
                                                       String directoryPath)
                                                       throws KettleException
Create a new directory, possibly by creating several sub-directies of / at the same time.

Parameters:
parentDirectory - the parent directory
directoryPath - The path to the new Repository Directory, to be created.
Returns:
The created sub-directory
Throws:
KettleException - In case something goes wrong

getTransformationNames

String[] getTransformationNames(ObjectId id_directory,
                                boolean includeDeleted)
                                throws KettleException
Throws:
KettleException

getJobObjects

List<RepositoryElementMetaInterface> getJobObjects(ObjectId id_directory,
                                                   boolean includeDeleted)
                                                   throws KettleException
Throws:
KettleException

getTransformationObjects

List<RepositoryElementMetaInterface> getTransformationObjects(ObjectId id_directory,
                                                              boolean includeDeleted)
                                                              throws KettleException
Throws:
KettleException

getJobAndTransformationObjects

List<RepositoryElementMetaInterface> getJobAndTransformationObjects(ObjectId id_directory,
                                                                    boolean includeDeleted)
                                                                    throws KettleException
Gets all job and transformation objects in the given directory. (Combines getJobObjects(ObjectId, boolean) and getTransformationObjects(ObjectId, boolean) into one operation.

Parameters:
id_directory - directory
includeDeleted - true to return deleted objects
Returns:
list of repository objects
Throws:
KettleException - In case something goes wrong

getJobNames

String[] getJobNames(ObjectId id_directory,
                     boolean includeDeleted)
                     throws KettleException
Throws:
KettleException

getDirectoryNames

String[] getDirectoryNames(ObjectId id_directory)
                           throws KettleException
Returns the child directory names of a parent directory

Parameters:
id_directory - parent directory id
Returns:
array of child names
Throws:
KettleException

insertLogEntry

ObjectId insertLogEntry(String description)
                        throws KettleException
Insert an entry in the audit trail of the repository. This is an optional operation and depends on the capabilities of the underlying repository.

Parameters:
The - description to be put in the audit trail of the repository.
Throws:
KettleException

insertStepDatabase

void insertStepDatabase(ObjectId id_transformation,
                        ObjectId id_step,
                        ObjectId id_database)
                        throws KettleException
Throws:
KettleException

insertJobEntryDatabase

void insertJobEntryDatabase(ObjectId id_job,
                            ObjectId id_jobentry,
                            ObjectId id_database)
                            throws KettleException
Throws:
KettleException

saveConditionStepAttribute

void saveConditionStepAttribute(ObjectId id_transformation,
                                ObjectId id_step,
                                String code,
                                Condition condition)
                                throws KettleException
This method saves the object ID of the condition object (if not null) in the step attributes

Parameters:
id_step -
code -
condition -
Throws:
KettleException

loadConditionFromStepAttribute

Condition loadConditionFromStepAttribute(ObjectId id_step,
                                         String code)
                                         throws KettleException
Load a condition from the repository with the Object ID stored in a step attribute.

Parameters:
id_step -
code -
Returns:
Throws:
KettleException

getStepAttributeBoolean

boolean getStepAttributeBoolean(ObjectId id_step,
                                int nr,
                                String code,
                                boolean def)
                                throws KettleException
Throws:
KettleException

getStepAttributeBoolean

boolean getStepAttributeBoolean(ObjectId id_step,
                                int nr,
                                String code)
                                throws KettleException
Throws:
KettleException

getStepAttributeBoolean

boolean getStepAttributeBoolean(ObjectId id_step,
                                String code)
                                throws KettleException
Throws:
KettleException

getStepAttributeInteger

long getStepAttributeInteger(ObjectId id_step,
                             int nr,
                             String code)
                             throws KettleException
Throws:
KettleException

getStepAttributeInteger

long getStepAttributeInteger(ObjectId id_step,
                             String code)
                             throws KettleException
Throws:
KettleException

getStepAttributeString

String getStepAttributeString(ObjectId id_step,
                              int nr,
                              String code)
                              throws KettleException
Throws:
KettleException

getStepAttributeString

String getStepAttributeString(ObjectId id_step,
                              String code)
                              throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       int nr,
                       String code,
                       String value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       String code,
                       String value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       int nr,
                       String code,
                       boolean value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       String code,
                       boolean value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       int nr,
                       String code,
                       long value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       String code,
                       long value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       int nr,
                       String code,
                       double value)
                       throws KettleException
Throws:
KettleException

saveStepAttribute

void saveStepAttribute(ObjectId id_transformation,
                       ObjectId id_step,
                       String code,
                       double value)
                       throws KettleException
Throws:
KettleException

countNrStepAttributes

int countNrStepAttributes(ObjectId id_step,
                          String code)
                          throws KettleException
Throws:
KettleException

countNrJobEntryAttributes

int countNrJobEntryAttributes(ObjectId id_jobentry,
                              String code)
                              throws KettleException
Throws:
KettleException

getJobEntryAttributeBoolean

boolean getJobEntryAttributeBoolean(ObjectId id_jobentry,
                                    String code)
                                    throws KettleException
Throws:
KettleException

getJobEntryAttributeBoolean

boolean getJobEntryAttributeBoolean(ObjectId id_jobentry,
                                    int nr,
                                    String code)
                                    throws KettleException
Throws:
KettleException

getJobEntryAttributeBoolean

boolean getJobEntryAttributeBoolean(ObjectId id_jobentry,
                                    String code,
                                    boolean def)
                                    throws KettleException
Throws:
KettleException

getJobEntryAttributeInteger

long getJobEntryAttributeInteger(ObjectId id_jobentry,
                                 String code)
                                 throws KettleException
Throws:
KettleException

getJobEntryAttributeInteger

long getJobEntryAttributeInteger(ObjectId id_jobentry,
                                 int nr,
                                 String code)
                                 throws KettleException
Throws:
KettleException

getJobEntryAttributeString

String getJobEntryAttributeString(ObjectId id_jobentry,
                                  String code)
                                  throws KettleException
Throws:
KettleException

getJobEntryAttributeString

String getJobEntryAttributeString(ObjectId id_jobentry,
                                  int nr,
                                  String code)
                                  throws KettleException
Throws:
KettleException

saveJobEntryAttribute

void saveJobEntryAttribute(ObjectId id_job,
                           ObjectId id_jobentry,
                           int nr,
                           String code,
                           String value)
                           throws KettleException
Throws:
KettleException

saveJobEntryAttribute

void saveJobEntryAttribute(ObjectId id_job,
                           ObjectId id_jobentry,
                           String code,
                           String value)
                           throws KettleException
Throws:
KettleException

saveJobEntryAttribute

void saveJobEntryAttribute(ObjectId id_job,
                           ObjectId id_jobentry,
                           int nr,
                           String code,
                           boolean value)
                           throws KettleException
Throws:
KettleException

saveJobEntryAttribute

void saveJobEntryAttribute(ObjectId id_job,
                           ObjectId id_jobentry,
                           String code,
                           boolean value)
                           throws KettleException
Throws:
KettleException

saveJobEntryAttribute

void saveJobEntryAttribute(ObjectId id_job,
                           ObjectId id_jobentry,
                           int nr,
                           String code,
                           long value)
                           throws KettleException
Throws:
KettleException

saveJobEntryAttribute

void saveJobEntryAttribute(ObjectId id_job,
                           ObjectId id_jobentry,
                           String code,
                           long value)
                           throws KettleException
Throws:
KettleException

loadDatabaseMetaFromStepAttribute

DatabaseMeta loadDatabaseMetaFromStepAttribute(ObjectId id_step,
                                               String code,
                                               List<DatabaseMeta> databases)
                                               throws KettleException
This method is introduced to avoid having to go over an integer/string/whatever in the interface and the step code.

Parameters:
id_step -
code -
Returns:
Throws:
KettleException

saveDatabaseMetaStepAttribute

void saveDatabaseMetaStepAttribute(ObjectId id_transformation,
                                   ObjectId id_step,
                                   String code,
                                   DatabaseMeta database)
                                   throws KettleException
This method saves the object ID of the database object (if not null) in the step attributes

Parameters:
id_transformation -
id_step -
code -
database -
Throws:
KettleException

loadDatabaseMetaFromJobEntryAttribute

DatabaseMeta loadDatabaseMetaFromJobEntryAttribute(ObjectId id_jobentry,
                                                   String nameCode,
                                                   String idCode,
                                                   List<DatabaseMeta> databases)
                                                   throws KettleException
This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.

Parameters:
id_step -
code -
Returns:
Throws:
KettleException

loadDatabaseMetaFromJobEntryAttribute

DatabaseMeta loadDatabaseMetaFromJobEntryAttribute(ObjectId id_jobentry,
                                                   String nameCode,
                                                   int nr,
                                                   String idCode,
                                                   List<DatabaseMeta> databases)
                                                   throws KettleException
This method is introduced to avoid having to go over an integer/string/whatever in the interface and the job entry code.

Parameters:
id_entry -
nameCode -
nr -
idcode -
databases -
Returns:
Throws:
KettleException

saveDatabaseMetaJobEntryAttribute

void saveDatabaseMetaJobEntryAttribute(ObjectId id_job,
                                       ObjectId id_jobentry,
                                       String nameCode,
                                       String idCode,
                                       DatabaseMeta database)
                                       throws KettleException
This method saves the object ID of the database object (if not null) in the job entry attributes

Parameters:
id_job -
id_jobentry -
idCode -
database -
Throws:
KettleException

saveDatabaseMetaJobEntryAttribute

void saveDatabaseMetaJobEntryAttribute(ObjectId id_job,
                                       ObjectId id_jobentry,
                                       int nr,
                                       String nameCode,
                                       String idCode,
                                       DatabaseMeta database)
                                       throws KettleException
This method saves the object ID of the database object (if not null) in the job entry attributes

Parameters:
id_job -
id_jobentry -
nr -
code -
database -
Throws:
KettleException

undeleteObject

void undeleteObject(RepositoryElementMetaInterface repositoryObject)
                    throws KettleException
Removes he deleted flag from a repository element in the repository. If it wasn't deleted, it remains untouched.

Parameters:
element - the repository element to restore
Throws:
KettleException - get throws in case something goes horribly wrong.

getServiceInterfaces

List<Class<? extends IRepositoryService>> getServiceInterfaces()
                                                               throws KettleException
Retrieves the current list of of IRepository Services.

Returns:
List of repository services
Throws:
KettleException - in case something goes horribly wrong.

getService

IRepositoryService getService(Class<? extends IRepositoryService> clazz)
                              throws KettleException
Retrieves a given repository service

Parameters:
service - class name
Returns:
repository service
Throws:
KettleException - in case something goes horribly wrong.

hasService

boolean hasService(Class<? extends IRepositoryService> clazz)
                   throws KettleException
Checks whether a given repository service is available or not

Parameters:
repository - service class that needs to be checked for support
Throws:
KettleException - in case something goes horribly wrong.

getObjectInformation

RepositoryObject getObjectInformation(ObjectId objectId,
                                      RepositoryObjectType objectType)
                                      throws KettleException
Get more information about a certain object ID in the form of the RepositoryObject

Parameters:
objectId - The ID of the object to get more information about.
objectType - The type of object to investigate.
Returns:
The repository object or null if nothing could be found.
Throws:
KettleException - In case there was a loading problem.

getConnectMessage

String getConnectMessage()
This is an informational message that a repository can display on connecting within Spoon. If a null is returned, no message is displayed to the end user.

Returns:
message

getJobsUsingDatabase

String[] getJobsUsingDatabase(ObjectId id_database)
                              throws KettleException
Get the repository version.

Returns:
The repository version as a string
Throws:
KettleException

getTransformationsUsingDatabase

String[] getTransformationsUsingDatabase(ObjectId id_database)
                                         throws KettleException
Throws:
KettleException

getImporter

IRepositoryImporter getImporter()
Returns:
the importer that will handle imports into this repository

getExporter

IRepositoryExporter getExporter()
Returns:
the exporter that will handle exports from this repository