JobMeta

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.pentaho.di.job
Class JobMeta

java.lang.Object
  org.pentaho.di.core.changed.ChangedFlag
      org.pentaho.di.job.JobMeta

All Implemented Interfaces:: Cloneable, Comparable<JobMeta>, ChangedFlagInterface, EngineMetaInterface, UndoInterface, LoggingObjectInterface, NamedParams, VariableSpace, XMLInterface, HasRepositoryInterface, RepositoryElementInterface, RepositoryObjectInterface, ResourceExportInterface, HasDatabasesInterface, HasSlaveServersInterface

public class JobMeta
extends ChangedFlag
implements Cloneable, Comparable<JobMeta>, XMLInterface, UndoInterface, HasDatabasesInterface, VariableSpace, EngineMetaInterface, ResourceExportInterface, HasSlaveServersInterface, NamedParams, RepositoryElementInterface, LoggingObjectInterface, HasRepositoryInterface
extends ChangedFlag
implements Cloneable, Comparable<JobMeta>, XMLInterface, UndoInterface, HasDatabasesInterface, VariableSpace, EngineMetaInterface, ResourceExportInterface, HasSlaveServersInterface, NamedParams, RepositoryElementInterface, LoggingObjectInterface, HasRepositoryInterface

Defines a Job and provides methods to load, save, verify, etc.

Since:: 11-08-2003
Author:: Matt

Field Summary
`boolean[]`	`max`
`static RepositoryObjectType`	`REPOSITORY_ELEMENT_TYPE`
`static String`	`STRING_SPECIAL`
`static String`	`STRING_SPECIAL_DUMMY`
`static String`	`STRING_SPECIAL_ERROR`
`static String`	`STRING_SPECIAL_OK`
`static String`	`STRING_SPECIAL_START`
`static int`	`TYPE_UNDO_CHANGE`
`static int`	`TYPE_UNDO_DELETE`
`static int`	`TYPE_UNDO_NEW`
`static int`	`TYPE_UNDO_POSITION`
`static String`	`XML_TAG`

Constructor Summary
`JobMeta()`
`JobMeta(InputStream inputStream, Repository rep, OverwritePrompter prompter)`
`JobMeta(Node jobnode, Repository rep, boolean ignoreRepositorySharedObjects, OverwritePrompter prompter)` Create a new JobMeta object by loading it from a a DOM node.
`JobMeta(Node jobnode, Repository rep, OverwritePrompter prompter)` Create a new JobMeta object by loading it from a a DOM node.
`JobMeta(String fname, Repository rep)`
`JobMeta(String fname, Repository rep, OverwritePrompter prompter)`
`JobMeta(VariableSpace parentSpace, String fname, Repository rep, OverwritePrompter prompter)` Load the job from the XML file specified.

Method Summary
`void`	`activateParameters()` Activate the currently set parameters
`void`	`addDatabase(DatabaseMeta ci)` Add a database connection to the transformation.
`void`	`addDatabase(int p, DatabaseMeta ci)` Add a database connection to the transformation on a certain location.
`void`	`addDefaults()`
`void`	`addFilenameChangedListener(FilenameChangedListener listener)`
`void`	`addJobEntry(int p, JobEntryCopy si)`
`void`	`addJobEntry(JobEntryCopy je)`
`void`	`addJobHop(int p, JobHopMeta hi)`
`void`	`addJobHop(JobHopMeta hi)`
`void`	`addNameChangedListener(NameChangedListener listener)`
`void`	`addNote(int p, NotePadMeta ni)`
`void`	`addNote(NotePadMeta ni)`
`void`	`addOrReplaceDatabase(DatabaseMeta databaseMeta)` Add a database connection to the transformation if that connection didn't exists yet.
`void`	`addOrReplaceSlaveServer(SlaveServer slaveServer)` Add a new slave server to the transformation if that didn't exist yet.
`void`	`addParameterDefinition(String key, String defValue, String description)` Add a parameter definition to this set.
`void`	`addUndo(Object[] from, Object[] to, int[] pos, Point[] prev, Point[] curr, int type_of_change, boolean nextAlso)` Add an undo operation to the undo list
`boolean`	`canSave()`
`void`	`checkJobEntries(List<CheckResultInterface> remarks, boolean only_selected, ProgressMonitorListener monitor)` Check all job entries within the job.
`void`	`clear()`
`void`	`clearChanged()`
`void`	`clearParameters()` Clear all parameters
`void`	`clearUndo()`
`Object`	`clone()`
`int`	`compare(JobMeta j1, JobMeta j2)` Compares two transformation on name, filename
`int`	`compareTo(JobMeta o)`
`List<JobEntryInterface>`	`composeJobEntryInterfaceList()` Create a unique list of job entry interfaces
`void`	`copyParametersFrom(NamedParams params)` Copy params to these named parameters (clearing out first).
`void`	`copyVariablesFrom(VariableSpace space)` Copy the variables from another space, without initializing with the defaults.
`int`	`countEntries(String name)`
`static JobEntryCopy`	`createDummyEntry()`
`static JobEntryCopy`	`createStartEntry()`
`String`	`environmentSubstitute(String aString)` Substitute the string using the current variable space.
`String[]`	`environmentSubstitute(String[] aString)` Replaces environment variables in an array of strings.
`boolean`	`equals(Object obj)`
`void`	`eraseParameters()` Clear the values.
`String`	`exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository)` Exports the object to a flat-file system, adding content with filename keys to a set of definitions.
`DatabaseMeta`	`findDatabase(String name)` Find a database connection by it's name
`static JobEntryInterface`	`findJobEntry(List<JobEntryInterface> jobentries, ObjectId id_jobentry)` Find a jobentry with a certain ID in a list of job entries.
`JobEntryCopy`	`findJobEntry(String full_name_nr)`
`JobEntryCopy`	`findJobEntry(String name, int nr, boolean searchHiddenToo)` Find an existing JobEntryCopy by it's name and number
`static JobEntryCopy`	`findJobEntryCopy(List<JobEntryCopy> jobcopies, ObjectId id_jobentry_copy)` Find a jobentrycopy with a certain ID in a list of job entry copies.
`JobHopMeta`	`findJobHop(JobEntryCopy from, JobEntryCopy to)`
`JobHopMeta`	`findJobHop(JobEntryCopy from, JobEntryCopy to, boolean includeDisabled)`
`JobHopMeta`	`findJobHop(String name)`
`JobHopMeta`	`findJobHopFrom(JobEntryCopy jge)`
`JobHopMeta`	`findJobHopTo(JobEntryCopy jge)`
`int`	`findMaxNr(String name)`
`JobEntryCopy`	`findNextJobEntry(JobEntryCopy from, int cnt)`
`int`	`findNrNextJobEntries(JobEntryCopy from)`
`int`	`findNrPrevJobEntries(JobEntryCopy from)`
`int`	`findNrPrevJobEntries(JobEntryCopy to, boolean info)`
`JobEntryCopy`	`findPrevJobEntry(JobEntryCopy to, int nr)`
`JobEntryCopy`	`findPrevJobEntry(JobEntryCopy to, int nr, boolean info)`
`SlaveServer`	`findSlaveServer(String serverString)` Find a slave server using the name
`JobEntryCopy`	`findStart()`
`int`	`findUnusedNr(String name)`
`JobEntryCopy[]`	`getAllJobGraphEntries(String name)`
`JobHopMeta[]`	`getAllJobHopsUsing(String name)`
`String`	`getAlternativeJobentryName(String entryname)` Proposes an alternative job entry name when the original already exists...
`String[]`	`getArguments()`
`boolean`	`getBooleanValueOfVariable(String variableName, boolean defaultValue)` This method returns a boolean for the new variable check boxes.
`ChannelLogTable`	`getChannelLogTable()`
`String`	`getContainerObjectId()`
`Date`	`getCreatedDate()`
`String`	`getCreatedUser()`
`DatabaseMeta`	`getDatabase(int i)` Retrieves a database connection information a a certain location.
`String[]`	`getDatabaseNames()`
`List<DatabaseMeta>`	`getDatabases()` Get an ArrayList of defined DatabaseInfo objects.
`String`	`getDefaultExtension()`
`String`	`getDescription()`
`JobEntryCopy`	`getDummy()`
`int[]`	`getEntryIndexes(List<JobEntryCopy> entries)`
`String`	`getExtendedDescription()`
`String`	`getFilename()`
`String`	`getFileType()`
`String[]`	`getFilterExtensions()`
`String[]`	`getFilterNames()`
`List<JobEntryCopy>`	`getJobCopies()`
`JobEntryCopy`	`getJobEntry(int i)`
`JobEntryCopy`	`getJobEntryCopy(int x, int y, int iconsize)`
`JobEntryLogTable`	`getJobEntryLogTable()`
`JobHopMeta`	`getJobHop(int i)`
`List<JobHopMeta>`	`getJobhops()`
`JobLogTable`	`getJobLogTable()`
`int`	`getJobstatus()` Get the status of the job
`String`	`getJobversion()`
`String`	`getLogChannelId()`
`LogLevel`	`getLogLevel()`
`List<LogTableInterface>`	`getLogTables()`
`Point`	`getMaximum()`
`int`	`getMaxUndo()` Get the maximum number of undo operations possible
`Point`	`getMinimum()` Get the minimum point on the canvas of a job
`Date`	`getModifiedDate()`
`String`	`getModifiedUser()`
`String`	`getName()` The name of the repository object
`NotePadMeta`	`getNote(int i)`
`NotePadMeta`	`getNote(int x, int y)`
`int[]`	`getNoteIndexes(List<NotePadMeta> notes)` Get an array of the locations of an array of notes
`List<NotePadMeta>`	`getNotes()`
`String`	`getObjectCopy()`
`ObjectId`	`getObjectId()` The id of the object
`String`	`getObjectName()`
`ObjectRevision`	`getObjectRevision()`
`LoggingObjectType`	`getObjectType()`
`String`	`getParameterDefault(String key)` Get the default value of a parameter.
`String`	`getParameterDescription(String key)` Get the description of a parameter.
`String`	`getParameterValue(String key)` Get the value of a parameter.
`LoggingObjectInterface`	`getParent()`
`VariableSpace`	`getParentVariableSpace()` Get the parent of the variable space.
`Date`	`getRegistrationDate()` Stub
`Repository`	`getRepository()`
`RepositoryDirectoryInterface`	`getRepositoryDirectory()`
`RepositoryObjectType`	`getRepositoryElementType()`
`List<ResourceReference>`	`getResourceDependencies()`
`List<JobEntryCopy>`	`getSelectedEntries()`
`Point[]`	`getSelectedLocations()`
`Point[]`	`getSelectedNoteLocations()` Get all the selected note locations
`List<NotePadMeta>`	`getSelectedNotes()`
`SharedObjects`	`getSharedObjects()`
`String`	`getSharedObjectsFile()`
`String[]`	`getSlaveServerNames()`
`List<SlaveServer>`	`getSlaveServers()`
`List<SQLStatement>`	`getSQLStatements(Repository repository, ProgressMonitorListener monitor)` Builds a list of all the SQL statements that this transformation needs in order to work properly.
`JobEntryCopy`	`getStart()`
`List<StringSearchResult>`	`getStringList(boolean searchSteps, boolean searchDatabases, boolean searchNotes)` Get a list of all the strings used in this job.
`int`	`getUndoSize()`
`List<String>`	`getUsedVariables()`
`String`	`getVariable(String variableName)` Get the value of a variable.
`String`	`getVariable(String variableName, String defaultValue)` Get the value of a variable with a default in case the variable is not found.
`String`	`getXML()` Describes the Object implementing this interface as XML
`boolean`	`hasChanged()`
`boolean`	`hasLoop(JobEntryCopy entry)`
`boolean`	`hasLoop(JobEntryCopy entry, JobEntryCopy lookup)`
`boolean`	`hasRepositoryReferences()`
`boolean`	`haveConnectionsChanged()` Checks whether or not the connections have changed.
`boolean`	`haveJobEntriesChanged()`
`boolean`	`haveJobHopsChanged()`
`boolean`	`haveNotesChanged()`
`int`	`indexOfDatabase(DatabaseMeta di)` Find the location of database
`int`	`indexOfJobEntry(JobEntryCopy ge)`
`int`	`indexOfJobHop(JobHopMeta he)`
`int`	`indexOfNote(NotePadMeta ni)`
`void`	`initializeVariablesFrom(VariableSpace parent)` Initialize variable space using the defaults, copy over the variables from the parent (using copyVariablesFrom()), after this the "injected" variables should be inserted (injectVariables()).
`void`	`injectVariables(Map<String,String> prop)` Inject variables.
`boolean`	`isBatchIdPassed()`
`boolean`	`isDatabaseConnectionUsed(DatabaseMeta databaseMeta)` This method asks all steps in the transformation whether or not the specified database connection is used.
`boolean`	`isEntryUsedInHops(JobEntryCopy jge)`
`boolean`	`isFileReference()`
`static boolean`	`isFileReference(String fileName, String transName)`
`boolean`	`isRepReference()`
`static boolean`	`isRepReference(String fileName, String transName)`
`String[]`	`listParameters()` List the parameters.
`String[]`	`listVariables()` List the variables (not the values) that are currently in the variable space.
`void`	`loadXML(Node jobnode, Repository rep, boolean ignoreRepositorySharedObjects, OverwritePrompter prompter)` Load a block of XML from an DOM node.
`void`	`loadXML(Node jobnode, Repository rep, OverwritePrompter prompter)`
`void`	`lookupRepositoryReferences(Repository repository)` Look up the references after import
`void`	`lowerNote(int p)`
`void`	`nameFromFilename()` Builds a name - if no name is set, yet - from the filename
`TransAction`	`nextUndo()` Get the next undo transaction on the list.
`int`	`nrDatabases()` Count the nr of databases in the transformation.
`int`	`nrJobEntries()`
`int`	`nrJobHops()`
`int`	`nrNotes()`
`TransAction`	`previousUndo()` Get the previous undo operation and change the undo pointer
`void`	`raiseNote(int p)`
`SharedObjects`	`readSharedObjects()`
`Object`	`realClone(boolean doClear)`
`void`	`removeDatabase(int i)` Removes a database from the transformation on a certain location.
`void`	`removeFilenameChangedListener(FilenameChangedListener listener)`
`void`	`removeJobEntry(int i)`
`void`	`removeJobHop(int i)`
`void`	`removeNameChangedListener(NameChangedListener listener)`
`void`	`removeNote(int i)`
`void`	`renameJobEntryIfNameCollides(JobEntryCopy je)` See if the name of the supplied job entry copy doesn't collide with any other job entry copy in the job.
`void`	`saveSharedObjects()`
`void`	`selectAll()`
`void`	`setArguments(String[] arguments)`
`void`	`setBatchIdPassed(boolean batchIdPassed)`
`void`	`setCarteObjectId(String containerObjectId)`
`void`	`setChanged(boolean ch)`
`void`	`setChannelLogTable(ChannelLogTable channelLogTable)`
`void`	`setCreatedDate(Date createdDate)`
`void`	`setCreatedUser(String createdUser)`
`void`	`setDatabases(List<DatabaseMeta> databases)`
`void`	`setDescription(String description)` Set the description of the job.
`void`	`setExtendedDescription(String extendedDescription)` Set the description of the job.
`void`	`setFilename(String newFilename)` Set the filename of the job
`void`	`setInternalKettleVariables()` Calls setInternalKettleVariables on the default object.
`void`	`setInternalKettleVariables(VariableSpace var)` This method sets various internal kettle variables that can be used by the transformation.
`void`	`setJobEntry(int idx, JobEntryCopy jec)`
`void`	`setJobEntryLogTable(JobEntryLogTable jobEntryLogTable)`
`void`	`setJobLogTable(JobLogTable jobLogTable)`
`void`	`setJobstatus(int jobStatus)` Set the status of the job.
`void`	`setJobversion(String jobVersion)` Set the version of the job.
`void`	`setLogLevel(LogLevel logLevel)`
`void`	`setMaxUndo(int mu)` Sets the maximum number of undo operations that are allowed.
`void`	`setModifiedDate(Date modifiedDate)`
`void`	`setModifiedUser(String modifiedUser)`
`void`	`setName(String newName)` Set the name of the job.
`void`	`setObjectId(ObjectId objectId)`
`void`	`setObjectRevision(ObjectRevision objectRevision)`
`void`	`setParameterValue(String key, String value)` Set the value of a parameter.
`void`	`setParentVariableSpace(VariableSpace parent)` Set the parent variable space
`void`	`setRepository(Repository repository)`
`void`	`setRepositoryDirectory(RepositoryDirectoryInterface directory)`
`void`	`setSharedObjects(SharedObjects sharedObjects)`
`void`	`setSharedObjectsFile(String sharedObjectsFile)`
`void`	`setSlaveServers(List<SlaveServer> slaveServers)`
`void`	`setVariable(String variableName, String variableValue)` Sets a variable in the Kettle Variables list.
`void`	`shareVariablesWith(VariableSpace space)` Share a variable space from another variable space.
`String`	`toString()`
`void`	`unselectAll()`
`TransAction`	`viewNextUndo()` Get the next undo transaction on the list.
`TransAction`	`viewPreviousUndo()` View previous undo, don't change undo position
`TransAction`	`viewThisUndo()` View current undo, don't change undo position

Methods inherited from class org.pentaho.di.core.changed.ChangedFlag
`addObserver, deleteObserver, notifyObservers, setChanged`

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

XML_TAG

public static final String XML_TAG

See Also:: Constant Field Values

REPOSITORY_ELEMENT_TYPE

public static final RepositoryObjectType REPOSITORY_ELEMENT_TYPE

TYPE_UNDO_CHANGE

public static final int TYPE_UNDO_CHANGE

See Also:: Constant Field Values

TYPE_UNDO_NEW

public static final int TYPE_UNDO_NEW

See Also:: Constant Field Values

TYPE_UNDO_DELETE

public static final int TYPE_UNDO_DELETE

See Also:: Constant Field Values

TYPE_UNDO_POSITION

public static final int TYPE_UNDO_POSITION

See Also:: Constant Field Values

STRING_SPECIAL

public static final String STRING_SPECIAL

See Also:: Constant Field Values

STRING_SPECIAL_START

public static final String STRING_SPECIAL_START

See Also:: Constant Field Values

STRING_SPECIAL_DUMMY

public static final String STRING_SPECIAL_DUMMY

See Also:: Constant Field Values

STRING_SPECIAL_OK

public static final String STRING_SPECIAL_OK

See Also:: Constant Field Values

STRING_SPECIAL_ERROR

public static final String STRING_SPECIAL_ERROR

See Also:: Constant Field Values

max

public boolean[] max

Constructor Detail

JobMeta

public JobMeta()

JobMeta

public JobMeta(String fname,
               Repository rep)
        throws KettleXMLException

Throws:: KettleXMLException

JobMeta

public JobMeta(String fname,
               Repository rep,
               OverwritePrompter prompter)
        throws KettleXMLException

Throws:: KettleXMLException

JobMeta

public JobMeta(VariableSpace parentSpace,
               String fname,
               Repository rep,
               OverwritePrompter prompter)
        throws KettleXMLException

Load the job from the XML file specified.

Parameters:: log - the logging channel; fname - The filename to load as a job; rep - The repository to bind againt, null if there is no repository available.
Throws:: KettleXMLException

JobMeta

public JobMeta(InputStream inputStream,
               Repository rep,
               OverwritePrompter prompter)
        throws KettleXMLException

Throws:: KettleXMLException

JobMeta

public JobMeta(Node jobnode,
               Repository rep,
               OverwritePrompter prompter)
        throws KettleXMLException

Create a new JobMeta object by loading it from a a DOM node.

Parameters:: jobnode - The node to load from; rep - The reference to a repository to load additional information from; prompter - The prompter to use in case a shared object gets overwritten
Throws:: KettleXMLException

JobMeta

public JobMeta(Node jobnode,
               Repository rep,
               boolean ignoreRepositorySharedObjects,
               OverwritePrompter prompter)
        throws KettleXMLException

Create a new JobMeta object by loading it from a a DOM node.

Parameters:: jobnode - The node to load from; rep - The reference to a repository to load additional information from; ignoreRepositorySharedObjects - Do not load shared objects, handled separately; prompter - The prompter to use in case a shared object gets overwritten
Throws:: KettleXMLException

Method Detail

getObjectId

public ObjectId getObjectId()

Description copied from interface: RepositoryObjectInterface

The id of the object

Specified by:: getObjectId in interface LoggingObjectInterface
Specified by:: getObjectId in interface RepositoryElementInterface
Specified by:: getObjectId in interface RepositoryObjectInterface

Returns:: the id of the object

setObjectId

public void setObjectId(ObjectId objectId)

Specified by:: setObjectId in interface EngineMetaInterface
Specified by:: setObjectId in interface RepositoryElementInterface

clear

public void clear()

addDefaults

public void addDefaults()

createStartEntry

public static final JobEntryCopy createStartEntry()

createDummyEntry

public static final JobEntryCopy createDummyEntry()

getStart

public JobEntryCopy getStart()

getDummy

public JobEntryCopy getDummy()

compare

public int compare(JobMeta j1,
                   JobMeta j2)

Compares two transformation on name, filename

compareTo

public int compareTo(JobMeta o)

Specified by:: compareTo in interface Comparable<JobMeta>

equals

public boolean equals(Object obj)

Overrides:: equals in class Object

clone

public Object clone()

Overrides:: clone in class Object

realClone

public Object realClone(boolean doClear)

getName

public String getName()

Description copied from interface: RepositoryObjectInterface

The name of the repository object

Specified by:: getName in interface EngineMetaInterface
Specified by:: getName in interface RepositoryElementInterface
Specified by:: getName in interface RepositoryObjectInterface

Returns:: the name of the object

setName

public void setName(String newName)

Set the name of the job.

Specified by:: setName in interface RepositoryElementInterface

Parameters:: newName - The new name of the job

nameFromFilename

public void nameFromFilename()

Builds a name - if no name is set, yet - from the filename

Specified by:: nameFromFilename in interface EngineMetaInterface

getRepositoryDirectory

public RepositoryDirectoryInterface getRepositoryDirectory()

Specified by:: getRepositoryDirectory in interface EngineMetaInterface
Specified by:: getRepositoryDirectory in interface LoggingObjectInterface
Specified by:: getRepositoryDirectory in interface RepositoryElementInterface

Returns:: Returns the directory.

setRepositoryDirectory

public void setRepositoryDirectory(RepositoryDirectoryInterface directory)

Specified by:: setRepositoryDirectory in interface RepositoryElementInterface

Parameters:: directory - The directory to set.

getFilename

public String getFilename()

Specified by:: getFilename in interface EngineMetaInterface
Specified by:: getFilename in interface LoggingObjectInterface

Returns:: the filename

setFilename

public void setFilename(String newFilename)

Set the filename of the job

Specified by:: setFilename in interface EngineMetaInterface

Parameters:: newFilename - The new filename of the job

getJobLogTable

public JobLogTable getJobLogTable()

setJobLogTable

public void setJobLogTable(JobLogTable jobLogTable)

getDatabases

public List<DatabaseMeta> getDatabases()

Description copied from interface: HasDatabasesInterface

Get an ArrayList of defined DatabaseInfo objects.

Specified by:: getDatabases in interface HasDatabasesInterface

Returns:: Returns the databases.

getDatabaseNames

public String[] getDatabaseNames()

setDatabases

public void setDatabases(List<DatabaseMeta> databases)

Specified by:: setDatabases in interface HasDatabasesInterface

Parameters:: databases - The databases to set.

setChanged

public void setChanged(boolean ch)

Specified by:: setChanged in interface ChangedFlagInterface
Overrides:: setChanged in class ChangedFlag

clearChanged

public void clearChanged()

Specified by:: clearChanged in interface ChangedFlagInterface
Specified by:: clearChanged in interface EngineMetaInterface
Overrides:: clearChanged in class ChangedFlag

hasChanged

public boolean hasChanged()

Specified by:: hasChanged in interface ChangedFlagInterface
Overrides:: hasChanged in class ChangedFlag

isDatabaseConnectionUsed

public boolean isDatabaseConnectionUsed(DatabaseMeta databaseMeta)

This method asks all steps in the transformation whether or not the specified database connection is used. The connection is used in the transformation if any of the steps uses it or if it is being used to log to.

Parameters:: databaseMeta - The connection to check
Returns:: true if the connection is used in this transformation.

getFileType

public String getFileType()

Specified by:: getFileType in interface EngineMetaInterface

getFilterNames

public String[] getFilterNames()

Specified by:: getFilterNames in interface EngineMetaInterface

getFilterExtensions

public String[] getFilterExtensions()

Specified by:: getFilterExtensions in interface EngineMetaInterface

getDefaultExtension

public String getDefaultExtension()

Specified by:: getDefaultExtension in interface EngineMetaInterface

getXML

public String getXML()

Description copied from interface: XMLInterface

Describes the Object implementing this interface as XML

Specified by:: getXML in interface EngineMetaInterface
Specified by:: getXML in interface XMLInterface

Returns:: the XML string for this object

isRepReference

public boolean isRepReference()

isFileReference

public boolean isFileReference()

isRepReference

public static boolean isRepReference(String fileName,
                                     String transName)

isFileReference

public static boolean isFileReference(String fileName,
                                      String transName)

loadXML

public void loadXML(Node jobnode,
                    Repository rep,
                    OverwritePrompter prompter)
             throws KettleXMLException

Throws:: KettleXMLException

loadXML

public void loadXML(Node jobnode,
                    Repository rep,
                    boolean ignoreRepositorySharedObjects,
                    OverwritePrompter prompter)
             throws KettleXMLException

Load a block of XML from an DOM node.

Parameters:: jobnode - The node to load from; rep - The reference to a repository to load additional information from; ignoreRepositorySharedObjects - Do not load shared objects, handled separately; prompter - The prompter to use in case a shared object gets overwritten
Throws:: KettleXMLException

readSharedObjects

public SharedObjects readSharedObjects()
                                throws KettleException

Throws:: KettleException

saveSharedObjects

public void saveSharedObjects()
                       throws KettleException

Specified by:: saveSharedObjects in interface EngineMetaInterface

Throws:: KettleException

findDatabase

public DatabaseMeta findDatabase(String name)

Find a database connection by it's name

Specified by:: findDatabase in interface HasDatabasesInterface

Parameters:: name - The database name to look for
Returns:: The database connection or null if nothing was found.

getJobEntryCopy

public JobEntryCopy getJobEntryCopy(int x,
                                    int y,
                                    int iconsize)

nrJobEntries

public int nrJobEntries()

nrJobHops

public int nrJobHops()

nrNotes

public int nrNotes()

nrDatabases

public int nrDatabases()

Description copied from interface: HasDatabasesInterface

Count the nr of databases in the transformation.

Specified by:: nrDatabases in interface HasDatabasesInterface

Returns:: The nr of databases

getJobHop

public JobHopMeta getJobHop(int i)

getJobEntry

public JobEntryCopy getJobEntry(int i)

getNote

public NotePadMeta getNote(int i)

getDatabase

public DatabaseMeta getDatabase(int i)

Description copied from interface: HasDatabasesInterface

Retrieves a database connection information a a certain location.

Specified by:: getDatabase in interface HasDatabasesInterface

Parameters:: i - The database number.
Returns:: The database connection information.

addJobEntry

public void addJobEntry(JobEntryCopy je)

addJobHop

public void addJobHop(JobHopMeta hi)

addNote

public void addNote(NotePadMeta ni)

addDatabase

public void addDatabase(DatabaseMeta ci)

Description copied from interface: HasDatabasesInterface

Add a database connection to the transformation.

Specified by:: addDatabase in interface HasDatabasesInterface

Parameters:: ci - The database connection information.

addJobEntry

public void addJobEntry(int p,
                        JobEntryCopy si)

addJobHop

public void addJobHop(int p,
                      JobHopMeta hi)

addNote

public void addNote(int p,
                    NotePadMeta ni)

addDatabase

public void addDatabase(int p,
                        DatabaseMeta ci)

Description copied from interface: HasDatabasesInterface

Add a database connection to the transformation on a certain location.

Specified by:: addDatabase in interface HasDatabasesInterface

Parameters:: p - The location; ci - The database connection information.

addOrReplaceDatabase

public void addOrReplaceDatabase(DatabaseMeta databaseMeta)

Description copied from interface: HasDatabasesInterface

Add a database connection to the transformation if that connection didn't exists yet. Otherwise, replace the connection in the transformation

Specified by:: addOrReplaceDatabase in interface HasDatabasesInterface

Parameters:: databaseMeta - The database connection information.

addOrReplaceSlaveServer

public void addOrReplaceSlaveServer(SlaveServer slaveServer)

Add a new slave server to the transformation if that didn't exist yet. Otherwise, replace it.

Parameters:: slaveServer - The slave server to be added.

removeJobEntry

public void removeJobEntry(int i)

removeJobHop

public void removeJobHop(int i)

removeNote

public void removeNote(int i)

raiseNote

public void raiseNote(int p)

lowerNote

public void lowerNote(int p)

removeDatabase

public void removeDatabase(int i)

Description copied from interface: HasDatabasesInterface

Removes a database from the transformation on a certain location.

Specified by:: removeDatabase in interface HasDatabasesInterface

Parameters:: i - The location

indexOfJobHop

public int indexOfJobHop(JobHopMeta he)

indexOfNote

public int indexOfNote(NotePadMeta ni)

indexOfJobEntry

public int indexOfJobEntry(JobEntryCopy ge)

indexOfDatabase

public int indexOfDatabase(DatabaseMeta di)

Description copied from interface: HasDatabasesInterface

Find the location of database

Specified by:: indexOfDatabase in interface HasDatabasesInterface

Parameters:: di - The database queried
Returns:: The location of the database, -1 if nothing was found.

setJobEntry

public void setJobEntry(int idx,
                        JobEntryCopy jec)

findJobEntry

public JobEntryCopy findJobEntry(String name,
                                 int nr,
                                 boolean searchHiddenToo)

Find an existing JobEntryCopy by it's name and number

Parameters:: name - The name of the job entry copy; nr - The number of the job entry copy
Returns:: The JobEntryCopy or null if nothing was found!

findJobEntry

public JobEntryCopy findJobEntry(String full_name_nr)

findJobHop

public JobHopMeta findJobHop(String name)

findJobHopFrom

public JobHopMeta findJobHopFrom(JobEntryCopy jge)

findJobHop

public JobHopMeta findJobHop(JobEntryCopy from,
                             JobEntryCopy to)

findJobHop

public JobHopMeta findJobHop(JobEntryCopy from,
                             JobEntryCopy to,
                             boolean includeDisabled)

findJobHopTo

public JobHopMeta findJobHopTo(JobEntryCopy jge)

findNrPrevJobEntries

public int findNrPrevJobEntries(JobEntryCopy from)

findPrevJobEntry

public JobEntryCopy findPrevJobEntry(JobEntryCopy to,
                                     int nr)

findNrPrevJobEntries

public int findNrPrevJobEntries(JobEntryCopy to,
                                boolean info)

findPrevJobEntry

public JobEntryCopy findPrevJobEntry(JobEntryCopy to,
                                     int nr,
                                     boolean info)

findNrNextJobEntries

public int findNrNextJobEntries(JobEntryCopy from)

findNextJobEntry

public JobEntryCopy findNextJobEntry(JobEntryCopy from,
                                     int cnt)

hasLoop

public boolean hasLoop(JobEntryCopy entry)

hasLoop

public boolean hasLoop(JobEntryCopy entry,
                       JobEntryCopy lookup)

isEntryUsedInHops

public boolean isEntryUsedInHops(JobEntryCopy jge)

countEntries

public int countEntries(String name)

findUnusedNr

public int findUnusedNr(String name)

findMaxNr

public int findMaxNr(String name)

getAlternativeJobentryName

public String getAlternativeJobentryName(String entryname)

Proposes an alternative job entry name when the original already exists...

Parameters:: entryname - The job entry name to find an alternative for..
Returns:: The alternative stepname.

getAllJobGraphEntries

public JobEntryCopy[] getAllJobGraphEntries(String name)

getAllJobHopsUsing

public JobHopMeta[] getAllJobHopsUsing(String name)

getNote

public NotePadMeta getNote(int x,
                           int y)

selectAll

public void selectAll()

unselectAll

public void unselectAll()

getMaxUndo

public int getMaxUndo()

Description copied from interface: UndoInterface

Get the maximum number of undo operations possible

Specified by:: getMaxUndo in interface UndoInterface

Returns:: The maximum number of undo operations that are allowed.

setMaxUndo

public void setMaxUndo(int mu)

Description copied from interface: UndoInterface

Sets the maximum number of undo operations that are allowed.

Specified by:: setMaxUndo in interface UndoInterface

Parameters:: mu - The maximum number of undo operations that are allowed.

getUndoSize

public int getUndoSize()

clearUndo

public void clearUndo()

addUndo

public void addUndo(Object[] from,
                    Object[] to,
                    int[] pos,
                    Point[] prev,
                    Point[] curr,
                    int type_of_change,
                    boolean nextAlso)

Description copied from interface: UndoInterface

Add an undo operation to the undo list

Specified by:: addUndo in interface UndoInterface

Parameters:: from - array of objects representing the old state; to - array of objectes representing the new state; pos - An array of object locations; prev - An array of points representing the old positions; curr - An array of points representing the new positions; type_of_change - The type of change that's being done to the transformation.; nextAlso - indicates that the next undo operation needs to follow this one.

previousUndo

public TransAction previousUndo()

Description copied from interface: UndoInterface

Get the previous undo operation and change the undo pointer

Specified by:: previousUndo in interface UndoInterface

Returns:: The undo transaction to be performed.

viewThisUndo

public TransAction viewThisUndo()

View current undo, don't change undo position

Specified by:: viewThisUndo in interface UndoInterface

Returns:: The current undo transaction

viewPreviousUndo

public TransAction viewPreviousUndo()

Description copied from interface: UndoInterface

View previous undo, don't change undo position

Specified by:: viewPreviousUndo in interface UndoInterface

Returns:: The previous undo transaction

nextUndo

public TransAction nextUndo()

Description copied from interface: UndoInterface

Get the next undo transaction on the list. Change the undo pointer.

Specified by:: nextUndo in interface UndoInterface

Returns:: The next undo transaction (for redo)

viewNextUndo

public TransAction viewNextUndo()

Description copied from interface: UndoInterface

Get the next undo transaction on the list.

Specified by:: viewNextUndo in interface UndoInterface

Returns:: The next undo transaction (for redo)

getMaximum

public Point getMaximum()

getMinimum

public Point getMinimum()

Get the minimum point on the canvas of a job

Returns:: Minimum coordinate of a step in the job

getSelectedLocations

public Point[] getSelectedLocations()

getSelectedNoteLocations

public Point[] getSelectedNoteLocations()

Get all the selected note locations

Returns:: The selected step and notes locations.

getSelectedEntries

public List<JobEntryCopy> getSelectedEntries()

getSelectedNotes

public List<NotePadMeta> getSelectedNotes()

Returns:: A list of all the selected notes.

getEntryIndexes

public int[] getEntryIndexes(List<JobEntryCopy> entries)

getNoteIndexes

public int[] getNoteIndexes(List<NotePadMeta> notes)

Get an array of the locations of an array of notes

Parameters:: notes - An array of notes
Returns:: an array of the locations of an array of notes

findStart

public JobEntryCopy findStart()

toString

public String toString()

Overrides:: toString in class Object

isBatchIdPassed

public boolean isBatchIdPassed()

Returns:: Returns the batchIdPassed.

setBatchIdPassed

public void setBatchIdPassed(boolean batchIdPassed)

Parameters:: batchIdPassed - The batchIdPassed to set.

getSQLStatements

public List<SQLStatement> getSQLStatements(Repository repository,
                                           ProgressMonitorListener monitor)
                                    throws KettleException

Builds a list of all the SQL statements that this transformation needs in order to work properly.

Returns:: An ArrayList of SQLStatement objects.
Throws:: KettleException

getArguments

public String[] getArguments()

Returns:: Returns the arguments.

setArguments

public void setArguments(String[] arguments)

Parameters:: arguments - The arguments to set.

getStringList

public List<StringSearchResult> getStringList(boolean searchSteps,
                                              boolean searchDatabases,
                                              boolean searchNotes)

Get a list of all the strings used in this job.

Returns:: A list of StringSearchResult with strings used in the job

getUsedVariables

public List<String> getUsedVariables()

haveConnectionsChanged

public boolean haveConnectionsChanged()

Description copied from interface: HasDatabasesInterface

Checks whether or not the connections have changed.

Specified by:: haveConnectionsChanged in interface HasDatabasesInterface

Returns:: True if the connections have been changed.

haveJobEntriesChanged

public boolean haveJobEntriesChanged()

haveJobHopsChanged

public boolean haveJobHopsChanged()

haveNotesChanged

public boolean haveNotesChanged()

getSharedObjectsFile

public String getSharedObjectsFile()

Returns:: the sharedObjectsFile

setSharedObjectsFile

public void setSharedObjectsFile(String sharedObjectsFile)

Parameters:: sharedObjectsFile - the sharedObjectsFile to set

setModifiedUser

public void setModifiedUser(String modifiedUser)

Specified by:: setModifiedUser in interface EngineMetaInterface

Parameters:: modifiedUser - The modifiedUser to set.

getModifiedUser

public String getModifiedUser()

Specified by:: getModifiedUser in interface EngineMetaInterface

Returns:: Returns the modifiedUser.

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Specified by:: setModifiedDate in interface EngineMetaInterface

Parameters:: modifiedDate - The modifiedDate to set.

getModifiedDate

public Date getModifiedDate()

Specified by:: getModifiedDate in interface EngineMetaInterface

Returns:: Returns the modifiedDate.

getDescription

public String getDescription()

Specified by:: getDescription in interface RepositoryElementInterface

Returns:: The description of the job

getExtendedDescription

public String getExtendedDescription()

Returns:: The extended description of the job

getJobversion

public String getJobversion()

Returns:: The version of the job

getJobstatus

public int getJobstatus()

Get the status of the job

setDescription

public void setDescription(String description)

Set the description of the job.

Specified by:: setDescription in interface RepositoryElementInterface

Parameters:: description - The new description of the job

setExtendedDescription

public void setExtendedDescription(String extendedDescription)

Set the description of the job.

Parameters:: extendedDescription - The new extended description of the job

setJobversion

public void setJobversion(String jobVersion)

Set the version of the job.

Parameters:: jobVersion - The new version description of the job

setJobstatus

public void setJobstatus(int jobStatus)

Set the status of the job.

Parameters:: jobStatus - The new status description of the job

getCreatedDate

public Date getCreatedDate()

Specified by:: getCreatedDate in interface EngineMetaInterface

Returns:: Returns the createdDate.

setCreatedDate

public void setCreatedDate(Date createdDate)

Specified by:: setCreatedDate in interface EngineMetaInterface

Parameters:: createdDate - The createdDate to set.

setCreatedUser

public void setCreatedUser(String createdUser)

Specified by:: setCreatedUser in interface EngineMetaInterface

Parameters:: createdUser - The createdUser to set.

getCreatedUser

public String getCreatedUser()

Specified by:: getCreatedUser in interface EngineMetaInterface

Returns:: Returns the createdUser.

findJobEntry

public static final JobEntryInterface findJobEntry(List<JobEntryInterface> jobentries,
                                                   ObjectId id_jobentry)

Find a jobentry with a certain ID in a list of job entries.

Parameters:: jobentries - The List of jobentries; id_jobentry - The id of the jobentry
Returns:: The JobEntry object if one was found, null otherwise.

findJobEntryCopy

public static final JobEntryCopy findJobEntryCopy(List<JobEntryCopy> jobcopies,
                                                  ObjectId id_jobentry_copy)

Find a jobentrycopy with a certain ID in a list of job entry copies.

Parameters:: jobcopies - The List of jobentry copies; id_jobentry_copy - The id of the jobentry copy
Returns:: The JobEntryCopy object if one was found, null otherwise.

setInternalKettleVariables

public void setInternalKettleVariables()

Calls setInternalKettleVariables on the default object.

Specified by:: setInternalKettleVariables in interface EngineMetaInterface

setInternalKettleVariables

public void setInternalKettleVariables(VariableSpace var)

This method sets various internal kettle variables that can be used by the transformation.