org.pentaho.di.base

Class AbstractMeta

java.lang.Object

org.pentaho.di.core.changed.ChangedFlag

org.pentaho.di.base.AbstractMeta

All Implemented Interfaces:

org.pentaho.di.core.AttributesInterface, ChangedFlagInterface, EngineMetaInterface, UndoInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.parameters.NamedParams, org.pentaho.di.core.variables.VariableSpace, HasRepositoryInterface, org.pentaho.di.repository.RepositoryElementInterface, org.pentaho.di.repository.RepositoryObjectInterface, HasDatabasesInterface, HasSlaveServersInterface

Direct Known Subclasses:

JobMeta, TransMeta

public abstract class AbstractMeta
extends ChangedFlag
implements UndoInterface, HasDatabasesInterface, org.pentaho.di.core.variables.VariableSpace, EngineMetaInterface, org.pentaho.di.core.parameters.NamedParams, HasSlaveServersInterface, org.pentaho.di.core.AttributesInterface, HasRepositoryInterface, org.pentaho.di.core.logging.LoggingObjectInterface

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_UNDO_CHANGE Constant = 1
static int	TYPE_UNDO_DELETE Constant = 3
static int	TYPE_UNDO_NEW Constant = 2
static int	TYPE_UNDO_POSITION Constant = 4

Constructor Summary

Constructors

Constructor and Description
AbstractMeta()

Method Summary

Methods

Modifier and Type	Method and Description
void	activateParameters()
void	addContentChangedListener(ContentChangedListener listener) Adds the passed ContentChangedListener to the list of listeners.
void	addDatabase(org.pentaho.di.core.database.DatabaseMeta ci) Add a database connection to the transformation.
void	addDatabase(int p, org.pentaho.di.core.database.DatabaseMeta ci) Add a database connection to the transformation on a certain location.
void	addFilenameChangedListener(FilenameChangedListener listener) Adds the filename changed listener.
void	addNameChangedListener(NameChangedListener listener) Adds the name changed listener.
void	addNote(int p, NotePadMeta ni) Add a new note at a certain location (i.e.
void	addNote(NotePadMeta ni) Add a new note.
void	addOrReplaceDatabase(org.pentaho.di.core.database.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)
void	addUndo(Object[] from, Object[] to, int[] pos, org.pentaho.di.core.gui.Point[] prev, org.pentaho.di.core.gui.Point[] curr, int type_of_change, boolean nextAlso) Add an undo operation to the undo list
boolean	canSave() Checks whether the job can be saved.
void	clear()
void	clearChanged() Clears the changed flags.
void	clearChangedDatabases() Clears the flags for whether the transformation's databases have changed.
void	clearParameters()
void	clearUndo() Clear undo.
void	copyParametersFrom(org.pentaho.di.core.parameters.NamedParams params)
void	copyVariablesFrom(org.pentaho.di.core.variables.VariableSpace space)
String	environmentSubstitute(String aString)
String[]	environmentSubstitute(String[] aString)
void	eraseParameters()
String	fieldSubstitute(String aString, org.pentaho.di.core.row.RowMetaInterface rowMeta, Object[] rowData)
org.pentaho.di.core.database.DatabaseMeta	findDatabase(String name) Find a database connection by it's name
SlaveServer	findSlaveServer(String serverString) Find a slave server using the name
String	getAttribute(String groupName, String key)
Map<String,String>	getAttributes(String groupName)
Map<String,Map<String,String>>	getAttributesMap()
boolean	getBooleanValueOfVariable(String variableName, boolean defaultValue)
ChannelLogTable	getChannelLogTable() Gets the channel log table for the job.
String	getContainerObjectId() Gets the container object id.
Date	getCreatedDate() Gets the date the transformation was created.
String	getCreatedUser() Gets the user by whom the transformation was created.
org.pentaho.di.core.database.DatabaseMeta	getDatabase(int i) Retrieves a database connection information a a certain location.
String[]	getDatabaseNames() Gets the database names.
List<org.pentaho.di.core.database.DatabaseMeta>	getDatabases() Returns a list of the databases.
String	getDescription() Gets the description of the job.
String	getExtendedDescription() Gets the extended description of the job.
String	getFilename() Gets the filename.
org.pentaho.di.core.logging.LogLevel	getLogLevel()
int	getMaxUndo() Get the maximum number of undo operations possible
org.pentaho.metastore.api.IMetaStore	getMetaStore()
Date	getModifiedDate() Gets the date the transformation was modified.
String	getModifiedUser() Gets the user who last modified the transformation.
String	getName() Get the name of the transformation.
NotePadMeta	getNote(int i) Gets the note.
NotePadMeta	getNote(int x, int y) Find the note that is located on a certain point on the canvas.
int[]	getNoteIndexes(List<NotePadMeta> notes) Get an array of the locations of an array of notes
List<NotePadMeta>	getNotes() Gets the notes.
String	getObjectCopy()
org.pentaho.di.repository.ObjectId	getObjectId()
String	getObjectName()
org.pentaho.di.repository.ObjectRevision	getObjectRevision()
String	getParameterDefault(String key)
String	getParameterDescription(String key)
String	getParameterValue(String key)
org.pentaho.di.core.logging.LoggingObjectInterface	getParent() Gets the interface to the parent log object.
org.pentaho.di.core.variables.VariableSpace	getParentVariableSpace()
Date	getRegistrationDate() Gets the registration date for the transformation.
Repository	getRepository() Gets the repository.
org.pentaho.di.repository.RepositoryDirectoryInterface	getRepositoryDirectory() Gets the directory.
List<NotePadMeta>	getSelectedNotes() Gets a list of all selected notes.
SharedObjects	getSharedObjects() Gets the shared objects.
String	getSharedObjectsFile() Gets the shared objects file.
String[]	getSlaveServerNames() Gets an array of slave server names.
List<SlaveServer>	getSlaveServers() Gets a list of slave servers.
int	getUndoSize() Gets the undo size.
String	getVariable(String variableName)
String	getVariable(String variableName, String defaultValue)
boolean	hasChanged() Checks whether or not this has changed.
boolean	haveConnectionsChanged() Checks whether or not the connections have changed.
boolean	haveNotesChanged() Checks whether or not any of the notes have been changed.
void	importFromMetaStore()
int	indexOfDatabase(org.pentaho.di.core.database.DatabaseMeta di) Find the location of database
int	indexOfNote(NotePadMeta ni) Finds the location (index) of the specified note.
void	initializeVariablesFrom(org.pentaho.di.core.variables.VariableSpace parent)
void	injectVariables(Map<String,String> prop)
String[]	listParameters()
String[]	listVariables()
void	lowerNote(int p) Lowers a note to the "bottom" of the list by removing the note at the specified index and re-inserting it at the front.
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	nrNotes() Gets the number of notes.
TransAction	previousUndo() Get the previous undo operation and change the undo pointer
void	raiseNote(int p) Raises a note to the "top" of the list by removing the note at the specified index and re-inserting it at the end.
void	removeContentChangedListener(ContentChangedListener listener) Removes the passed ContentChangedListener from the list of listeners.
void	removeDatabase(int i) Removes a database from the transformation on a certain location.
void	removeFilenameChangedListener(FilenameChangedListener listener) Removes the filename changed listener.
void	removeNameChangedListener(NameChangedListener listener) Removes the name changed listener.
void	removeNote(int i) Removes a note at a certain location (i.e.
void	setAttribute(String groupName, String key, String value)
void	setAttributes(String groupName, Map<String,String> attributes)
void	setAttributesMap(Map<String,Map<String,String>> attributesMap)
void	setCarteObjectId(String containerObjectId) Sets the carte object id.
void	setChanged(boolean ch) Sets whether or not this has changed.
void	setChannelLogTable(ChannelLogTable channelLogTable) Sets the channel log table for the job.
void	setCreatedDate(Date createdDate) Sets the date the transformation was created.
void	setCreatedUser(String createdUser) Sets the user by whom the transformation was created.
void	setDatabases(List<org.pentaho.di.core.database.DatabaseMeta> databases) Sets the 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.
abstract void	setInternalKettleVariables(org.pentaho.di.core.variables.VariableSpace var) This method sets various internal kettle variables.
void	setLogLevel(org.pentaho.di.core.logging.LogLevel logLevel) Sets the log level.
void	setMaxUndo(int mu) Sets the maximum number of undo operations that are allowed.
void	setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)
void	setModifiedDate(Date modifiedDate) Sets the date the transformation was modified.
void	setModifiedUser(String modifiedUser) Sets the user who last modified the transformation.
void	setName(String newName) Set the name.
void	setObjectId(org.pentaho.di.repository.ObjectId objectId) Set the database ID for this in the repository.
void	setObjectRevision(org.pentaho.di.repository.ObjectRevision objectRevision)
void	setParameterValue(String key, String value)
void	setParentVariableSpace(org.pentaho.di.core.variables.VariableSpace parent)
void	setRepository(Repository repository) Sets the repository.
void	setRepositoryDirectory(org.pentaho.di.repository.RepositoryDirectoryInterface directory) Sets the directory.
void	setSharedObjects(SharedObjects sharedObjects) Sets the shared objects.
void	setSharedObjectsFile(String sharedObjectsFile) Sets the shared objects file.
void	setSlaveServers(List<SlaveServer> slaveServers) Sets the slave servers.
void	setVariable(String variableName, String variableValue)
void	shareVariablesWith(org.pentaho.di.core.variables.VariableSpace space)
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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.di.core.EngineMetaInterface

getDefaultExtension, getFileType, getFilterExtensions, getFilterNames, getXML, saveSharedObjects

Methods inherited from interface org.pentaho.di.repository.RepositoryElementInterface

getRepositoryElementType

Methods inherited from interface org.pentaho.di.core.logging.LoggingObjectInterface

getLogChannelId, getObjectType, isForcingSeparateLogging, isGatheringMetrics, setForcingSeparateLogging, setGatheringMetrics

Field Detail

TYPE_UNDO_CHANGE

public static final int TYPE_UNDO_CHANGE

Constant = 1

See Also:

Constant Field Values

TYPE_UNDO_NEW

public static final int TYPE_UNDO_NEW

Constant = 2

See Also:

Constant Field Values

TYPE_UNDO_DELETE

public static final int TYPE_UNDO_DELETE

Constant = 3

See Also:

Constant Field Values

TYPE_UNDO_POSITION

public static final int TYPE_UNDO_POSITION

Constant = 4

See Also:

Constant Field Values

Constructor Detail

AbstractMeta

public AbstractMeta()

Method Detail

getObjectId

public org.pentaho.di.repository.ObjectId getObjectId()

Specified by:

getObjectId in interface org.pentaho.di.core.logging.LoggingObjectInterface

Specified by:

getObjectId in interface org.pentaho.di.repository.RepositoryElementInterface

Specified by:

getObjectId in interface org.pentaho.di.repository.RepositoryObjectInterface

setObjectId

public void setObjectId(org.pentaho.di.repository.ObjectId objectId)

Description copied from interface: EngineMetaInterface

Set the database ID for this in the repository.

Specified by:

setObjectId in interface EngineMetaInterface

Specified by:

setObjectId in interface org.pentaho.di.repository.RepositoryElementInterface

Parameters:

objectId - the database ID for this in the repository

getContainerObjectId

public String getContainerObjectId()

Gets the container object id.

Specified by:

getContainerObjectId in interface org.pentaho.di.core.logging.LoggingObjectInterface

Returns:

the carteObjectId

setCarteObjectId

public void setCarteObjectId(String containerObjectId)

Sets the carte object id.

Parameters:

containerObjectId - the execution container Object id to set

getName

public String getName()

Get the name of the transformation.

Specified by:

getName in interface EngineMetaInterface

Specified by:

getName in interface org.pentaho.di.repository.RepositoryElementInterface

Specified by:

getName in interface org.pentaho.di.repository.RepositoryObjectInterface

Returns:

The name of the transformation

setName

public void setName(String newName)

Set the name.

Specified by:

setName in interface org.pentaho.di.repository.RepositoryElementInterface

Parameters:

newName - The new name

getDescription

public String getDescription()

Gets the description of the job.

Specified by:

getDescription in interface org.pentaho.di.repository.RepositoryElementInterface

Returns:

The description of the job

setDescription

public void setDescription(String description)

Set the description of the job.

Specified by:

setDescription in interface org.pentaho.di.repository.RepositoryElementInterface

Parameters:

description - The new description of the job

getExtendedDescription

public String getExtendedDescription()

Gets the extended description of the job.

Returns:

The extended 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

nameFromFilename

public void nameFromFilename()

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

Specified by:

nameFromFilename in interface EngineMetaInterface

getFilename

public String getFilename()

Gets the filename.

Specified by:

getFilename in interface EngineMetaInterface

Specified by:

getFilename in interface org.pentaho.di.core.logging.LoggingObjectInterface

Returns:

filename

See Also:

EngineMetaInterface.getFilename()

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

getRepositoryDirectory

public org.pentaho.di.repository.RepositoryDirectoryInterface getRepositoryDirectory()

Gets the directory.

Specified by:

getRepositoryDirectory in interface EngineMetaInterface

Specified by:

getRepositoryDirectory in interface org.pentaho.di.core.logging.LoggingObjectInterface

Specified by:

getRepositoryDirectory in interface org.pentaho.di.repository.RepositoryElementInterface

Returns:

Returns the directory.

setRepositoryDirectory

public void setRepositoryDirectory(org.pentaho.di.repository.RepositoryDirectoryInterface directory)

Sets the directory.

Specified by:

setRepositoryDirectory in interface org.pentaho.di.repository.RepositoryElementInterface

Parameters:

directory - The directory to set.

getRepository

public Repository getRepository()

Gets the repository.

Specified by:

getRepository in interface HasRepositoryInterface

Returns:

the repository

setRepository

public void setRepository(Repository repository)

Sets the repository.

Specified by:

setRepository in interface HasRepositoryInterface

Parameters:

repository - the repository to set

setInternalKettleVariables

public void setInternalKettleVariables()

Calls setInternalKettleVariables on the default object.

Specified by:

setInternalKettleVariables in interface EngineMetaInterface

setInternalKettleVariables

public abstract void setInternalKettleVariables(org.pentaho.di.core.variables.VariableSpace var)

This method sets various internal kettle variables.

findDatabase

public org.pentaho.di.core.database.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.

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

getDatabase

public org.pentaho.di.core.database.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.

importFromMetaStore

public void importFromMetaStore()
                         throws org.pentaho.metastore.api.exceptions.MetaStoreException,
                                org.pentaho.di.core.exception.KettlePluginException

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

org.pentaho.di.core.exception.KettlePluginException

addNameChangedListener

public void addNameChangedListener(NameChangedListener listener)

Adds the name changed listener.

Parameters:

listener - the listener

removeNameChangedListener

public void removeNameChangedListener(NameChangedListener listener)

Removes the name changed listener.

Parameters:

listener - the listener

addFilenameChangedListener

public void addFilenameChangedListener(FilenameChangedListener listener)

Adds the filename changed listener.

Parameters:

listener - the listener

removeFilenameChangedListener

public void removeFilenameChangedListener(FilenameChangedListener listener)

Removes the filename changed listener.

Parameters:

listener - the listener

addContentChangedListener

public void addContentChangedListener(ContentChangedListener listener)

Adds the passed ContentChangedListener to the list of listeners.

Parameters:

listener -

removeContentChangedListener

public void removeContentChangedListener(ContentChangedListener listener)

Removes the passed ContentChangedListener from the list of listeners.

Parameters:

listener -

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.

getSlaveServers

public List<SlaveServer> getSlaveServers()

Gets a list of slave servers.

Specified by:

getSlaveServers in interface HasSlaveServersInterface

Returns:

the slaveServer list

setSlaveServers

public void setSlaveServers(List<SlaveServer> slaveServers)

Sets the slave servers.

Parameters:

slaveServers - the slaveServers to set

findSlaveServer

public SlaveServer findSlaveServer(String serverString)

Find a slave server using the name

Parameters:

serverString - the name of the slave server

Returns:

the slave server or null if we couldn't spot an approriate entry.

getSlaveServerNames

public String[] getSlaveServerNames()

Gets an array of slave server names.

Returns:

An array list slave server names

addUndo

public void addUndo(Object[] from,
           Object[] to,
           int[] pos,
           org.pentaho.di.core.gui.Point[] prev,
           org.pentaho.di.core.gui.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.

clearUndo

public void clearUndo()

Clear undo.

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)

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

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()

Gets the undo size.

Returns:

the undo size

setAttributesMap

public void setAttributesMap(Map<String,Map<String,String>> attributesMap)

Specified by:

setAttributesMap in interface org.pentaho.di.core.AttributesInterface

getAttributesMap

public Map<String,Map<String,String>> getAttributesMap()

Specified by:

getAttributesMap in interface org.pentaho.di.core.AttributesInterface

setAttribute

public void setAttribute(String groupName,
                String key,
                String value)

Specified by:

setAttribute in interface org.pentaho.di.core.AttributesInterface

setAttributes

public void setAttributes(String groupName,
                 Map<String,String> attributes)

Specified by:

setAttributes in interface org.pentaho.di.core.AttributesInterface

getAttributes

public Map<String,String> getAttributes(String groupName)

Specified by:

getAttributes in interface org.pentaho.di.core.AttributesInterface

getAttribute

public String getAttribute(String groupName,
                  String key)

Specified by:

getAttribute in interface org.pentaho.di.core.AttributesInterface

addNote

public void addNote(int p,
           NotePadMeta ni)

Add a new note at a certain location (i.e. the specified index). Also marks that the notes have changed.

Parameters:

p - The index into the notes list

ni - The note to be added.

addNote

public void addNote(NotePadMeta ni)

Add a new note. Also marks that the notes have changed.

Parameters:

ni - The note to be added.

getNote

public NotePadMeta getNote(int x,
                  int y)

Find the note that is located on a certain point on the canvas.

Parameters:

x - the x-coordinate of the point queried

y - the y-coordinate of the point queried

Returns:

The note information if a note is located at the point. Otherwise, if nothing was found: null.

getNote

public NotePadMeta getNote(int i)

Gets the note.

Parameters:

i - the i

Returns:

the note

getNotes

public List<NotePadMeta> getNotes()

Gets the notes.

Returns:

the notes

getSelectedNotes

public List<NotePadMeta> getSelectedNotes()

Gets a list of all selected notes.

Returns:

A list of all the selected notes.

indexOfNote

public int indexOfNote(NotePadMeta ni)

Finds the location (index) of the specified note.

Parameters:

ni - The note queried

Returns:

The location of the note, or -1 if nothing was found.

lowerNote

public void lowerNote(int p)

Lowers a note to the "bottom" of the list by removing the note at the specified index and re-inserting it at the front. Also marks that the notes have changed.

Parameters:

p - the index into the notes list.

nrNotes

public int nrNotes()

Gets the number of notes.

Returns:

The number of notes.

raiseNote

public void raiseNote(int p)

Raises a note to the "top" of the list by removing the note at the specified index and re-inserting it at the end. Also marks that the notes have changed.

Parameters:

p - the index into the notes list.

removeNote

public void removeNote(int i)

Removes a note at a certain location (i.e. the specified index). Also marks that the notes have changed.

Parameters:

i - The index into the notes list

haveNotesChanged

public boolean haveNotesChanged()

Checks whether or not any of the notes have been changed.

Returns:

true if the notes have been changed, false otherwise

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

getChannelLogTable

public ChannelLogTable getChannelLogTable()

Gets the channel log table for the job.

Returns:

the channel log table for the job.

addOrReplaceDatabase

public void addOrReplaceDatabase(org.pentaho.di.core.database.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.

addDatabase

public void addDatabase(org.pentaho.di.core.database.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.

addDatabase

public void addDatabase(int p,
               org.pentaho.di.core.database.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.

getDatabases

public List<org.pentaho.di.core.database.DatabaseMeta> getDatabases()

Returns a list of the databases.

Specified by:

getDatabases in interface HasDatabasesInterface

Returns:

Returns the databases.

getDatabaseNames

public String[] getDatabaseNames()

Gets the database names.

Returns:

the database names

indexOfDatabase

public int indexOfDatabase(org.pentaho.di.core.database.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.

setDatabases

public void setDatabases(List<org.pentaho.di.core.database.DatabaseMeta> databases)

Sets the databases.

Specified by:

setDatabases in interface HasDatabasesInterface

Parameters:

databases - The databases to set.

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.

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

clearChangedDatabases

public void clearChangedDatabases()

Clears the flags for whether the transformation's databases have changed.

setChannelLogTable

public void setChannelLogTable(ChannelLogTable channelLogTable)

Sets the channel log table for the job.

Parameters:

channelLogTable - the channelLogTable to set

copyVariablesFrom

public void copyVariablesFrom(org.pentaho.di.core.variables.VariableSpace space)

Specified by:

copyVariablesFrom in interface org.pentaho.di.core.variables.VariableSpace

environmentSubstitute

public String environmentSubstitute(String aString)

Specified by:

environmentSubstitute in interface org.pentaho.di.core.variables.VariableSpace

environmentSubstitute

public String[] environmentSubstitute(String[] aString)

Specified by:

environmentSubstitute in interface org.pentaho.di.core.variables.VariableSpace

fieldSubstitute

public String fieldSubstitute(String aString,
                     org.pentaho.di.core.row.RowMetaInterface rowMeta,
                     Object[] rowData)
                       throws org.pentaho.di.core.exception.KettleValueException

Specified by:

fieldSubstitute in interface org.pentaho.di.core.variables.VariableSpace

Throws:

org.pentaho.di.core.exception.KettleValueException

getParentVariableSpace

public org.pentaho.di.core.variables.VariableSpace getParentVariableSpace()

Specified by:

getParentVariableSpace in interface org.pentaho.di.core.variables.VariableSpace

setParentVariableSpace

public void setParentVariableSpace(org.pentaho.di.core.variables.VariableSpace parent)

Specified by:

setParentVariableSpace in interface org.pentaho.di.core.variables.VariableSpace

getVariable

public String getVariable(String variableName,
                 String defaultValue)

Specified by:

getVariable in interface org.pentaho.di.core.variables.VariableSpace

getVariable

public String getVariable(String variableName)

Specified by:

getVariable in interface org.pentaho.di.core.variables.VariableSpace

getBooleanValueOfVariable

public boolean getBooleanValueOfVariable(String variableName,
                                boolean defaultValue)

Specified by:

getBooleanValueOfVariable in interface org.pentaho.di.core.variables.VariableSpace

initializeVariablesFrom

public void initializeVariablesFrom(org.pentaho.di.core.variables.VariableSpace parent)

Specified by:

initializeVariablesFrom in interface org.pentaho.di.core.variables.VariableSpace

listVariables

public String[] listVariables()

Specified by:

listVariables in interface org.pentaho.di.core.variables.VariableSpace

setVariable

public void setVariable(String variableName,
               String variableValue)

Specified by:

setVariable in interface org.pentaho.di.core.variables.VariableSpace

shareVariablesWith

public void shareVariablesWith(org.pentaho.di.core.variables.VariableSpace space)

Specified by:

shareVariablesWith in interface org.pentaho.di.core.variables.VariableSpace

injectVariables

public void injectVariables(Map<String,String> prop)

Specified by:

injectVariables in interface org.pentaho.di.core.variables.VariableSpace

addParameterDefinition

public void addParameterDefinition(String key,
                          String defValue,
                          String description)
                            throws org.pentaho.di.core.parameters.DuplicateParamException

Specified by:

addParameterDefinition in interface org.pentaho.di.core.parameters.NamedParams

Throws:

org.pentaho.di.core.parameters.DuplicateParamException

getParameterDescription

public String getParameterDescription(String key)
                               throws org.pentaho.di.core.parameters.UnknownParamException

Specified by:

getParameterDescription in interface org.pentaho.di.core.parameters.NamedParams

Throws:

org.pentaho.di.core.parameters.UnknownParamException

getParameterDefault

public String getParameterDefault(String key)
                           throws org.pentaho.di.core.parameters.UnknownParamException

Specified by:

getParameterDefault in interface org.pentaho.di.core.parameters.NamedParams

Throws:

org.pentaho.di.core.parameters.UnknownParamException

getParameterValue

public String getParameterValue(String key)
                         throws org.pentaho.di.core.parameters.UnknownParamException

Specified by:

getParameterValue in interface org.pentaho.di.core.parameters.NamedParams

Throws:

org.pentaho.di.core.parameters.UnknownParamException

listParameters

public String[] listParameters()

Specified by:

listParameters in interface org.pentaho.di.core.parameters.NamedParams

setParameterValue

public void setParameterValue(String key,
                     String value)
                       throws org.pentaho.di.core.parameters.UnknownParamException

Specified by:

setParameterValue in interface org.pentaho.di.core.parameters.NamedParams

Throws:

org.pentaho.di.core.parameters.UnknownParamException

eraseParameters

public void eraseParameters()

Specified by:

eraseParameters in interface org.pentaho.di.core.parameters.NamedParams

clearParameters

public void clearParameters()

Specified by:

clearParameters in interface org.pentaho.di.core.parameters.NamedParams

copyParametersFrom

public void copyParametersFrom(org.pentaho.di.core.parameters.NamedParams params)

Specified by:

copyParametersFrom in interface org.pentaho.di.core.parameters.NamedParams

activateParameters

public void activateParameters()

Specified by:

activateParameters in interface org.pentaho.di.core.parameters.NamedParams

getLogLevel

public org.pentaho.di.core.logging.LogLevel getLogLevel()

Specified by:

getLogLevel in interface org.pentaho.di.core.logging.LoggingObjectInterface

setLogLevel

public void setLogLevel(org.pentaho.di.core.logging.LogLevel logLevel)

Sets the log level.

Parameters:

logLevel - the new log level

getMetaStore

public org.pentaho.metastore.api.IMetaStore getMetaStore()

setMetaStore

public void setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)

getSharedObjectsFile

public String getSharedObjectsFile()

Gets the shared objects file.

Returns:

the sharedObjectsFile

setSharedObjectsFile

public void setSharedObjectsFile(String sharedObjectsFile)

Sets the shared objects file.

Parameters:

sharedObjectsFile - the sharedObjectsFile to set

getSharedObjects

public SharedObjects getSharedObjects()

Gets the shared objects.

Returns:

the sharedObjects

setSharedObjects

public void setSharedObjects(SharedObjects sharedObjects)

Sets the shared objects.

Parameters:

sharedObjects - the sharedObjects to set

getCreatedDate

public Date getCreatedDate()

Gets the date the transformation was created.

Specified by:

getCreatedDate in interface EngineMetaInterface

Returns:

the date the transformation was created.

setCreatedDate

public void setCreatedDate(Date createdDate)

Sets the date the transformation was created.

Specified by:

setCreatedDate in interface EngineMetaInterface

Parameters:

createdDate - The creation date to set.

setCreatedUser

public void setCreatedUser(String createdUser)

Sets the user by whom the transformation was created.

Specified by:

setCreatedUser in interface EngineMetaInterface

Parameters:

createdUser - The user to set.

getCreatedUser

public String getCreatedUser()

Gets the user by whom the transformation was created.

Specified by:

getCreatedUser in interface EngineMetaInterface

Returns:

the user by whom the transformation was created.

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Sets the date the transformation was modified.

Specified by:

setModifiedDate in interface EngineMetaInterface

Parameters:

modifiedDate - The modified date to set.

getModifiedDate

public Date getModifiedDate()

Gets the date the transformation was modified.

Specified by:

getModifiedDate in interface EngineMetaInterface

Returns:

the date the transformation was modified.

setModifiedUser

public void setModifiedUser(String modifiedUser)

Sets the user who last modified the transformation.

Specified by:

setModifiedUser in interface EngineMetaInterface

Parameters:

modifiedUser - The user name to set.

getModifiedUser

public String getModifiedUser()

Gets the user who last modified the transformation.

Specified by:

getModifiedUser in interface EngineMetaInterface

Returns:

the user who last modified the transformation.

clear

public void clear()

clearChanged

public void clearChanged()

Description copied from class: ChangedFlag

Clears the changed flags.

Specified by:

clearChanged in interface ChangedFlagInterface

Specified by:

clearChanged in interface EngineMetaInterface

Overrides:

clearChanged in class ChangedFlag

setChanged

public void setChanged(boolean ch)

Description copied from class: ChangedFlag

Sets whether or not this has changed.

Specified by:

setChanged in interface ChangedFlagInterface

Overrides:

setChanged in class ChangedFlag

canSave

public boolean canSave()

Checks whether the job can be saved. For JobMeta, this method always returns true

Specified by:

canSave in interface EngineMetaInterface

Returns:

true

See Also:

EngineMetaInterface.canSave()

hasChanged

public boolean hasChanged()

Description copied from class: ChangedFlag

Checks whether or not this has changed.

Specified by:

hasChanged in interface ChangedFlagInterface

Overrides:

hasChanged in class ChangedFlag

Returns:

true if the this has changed, false otherwise

getRegistrationDate

public Date getRegistrationDate()

Gets the registration date for the transformation. For AbstractMeta, this method always returns null.

Specified by:

getRegistrationDate in interface org.pentaho.di.core.logging.LoggingObjectInterface

Returns:

null

getParent

public org.pentaho.di.core.logging.LoggingObjectInterface getParent()

Gets the interface to the parent log object. For AbstractMeta, this method always returns null.

Specified by:

getParent in interface org.pentaho.di.core.logging.LoggingObjectInterface

Returns:

null

See Also:

LoggingObjectInterface.getParent()

getObjectName

public String getObjectName()

Specified by:

getObjectName in interface org.pentaho.di.core.logging.LoggingObjectInterface

getObjectCopy

public String getObjectCopy()

Specified by:

getObjectCopy in interface org.pentaho.di.core.logging.LoggingObjectInterface

getObjectRevision

public org.pentaho.di.repository.ObjectRevision getObjectRevision()

Specified by:

getObjectRevision in interface org.pentaho.di.core.logging.LoggingObjectInterface

Specified by:

getObjectRevision in interface org.pentaho.di.repository.RepositoryElementInterface

setObjectRevision

public void setObjectRevision(org.pentaho.di.repository.ObjectRevision objectRevision)

Specified by:

setObjectRevision in interface org.pentaho.di.repository.RepositoryElementInterface