Package org.apache.hop.core
Interface IEngineMeta
-
- All Known Implementing Classes:
AbstractMeta,PipelineMeta,WorkflowMeta
public interface IEngineMeta
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancanSave()Returns whether or not the this can be saved.voidclearChanged()Clears the changed flag of this.DategetCreatedDate()Gets the date the pipeline was created.StringgetCreatedUser()Gets the user by whom this was created.StringgetFilename()Get the filename (if any).DategetModifiedDate()Gets the date this was modified.StringgetModifiedUser()Gets the user who last modified this.StringgetName()Gets the name.StringgetXml(IVariables variables)Gets the XML representation.booleanisNameSynchronizedWithFilename()voidnameFromFilename()Builds a name for this.voidsetCreatedDate(Date date)Sets the date the pipeline was created.voidsetCreatedUser(String createduser)Sets the user by whom this was created.voidsetFilename(String filename)Sets the filename.voidsetInternalHopVariables(IVariables variables)Sets the internal hop variables on the provided IVariablesvoidsetModifiedDate(Date date)Sets the date this was modified.voidsetModifiedUser(String user)Sets the user who last modified this.voidsetName(String name)Set the name of the engine metadata objectvoidsetNameSynchronizedWithFilename(boolean nameSynchronizedWithFilename)
-
-
-
Method Detail
-
setFilename
void setFilename(String filename)
Sets the filename.- Parameters:
filename-
-
setName
void setName(String name)
Set the name of the engine metadata object- Parameters:
name-
-
getName
String getName()
Gets the name.- Returns:
- name
-
nameFromFilename
void nameFromFilename()
Builds a name for this. If no name is yet set, create the name from the filename.
-
clearChanged
void clearChanged()
Clears the changed flag of this.
-
getXml
String getXml(IVariables variables) throws HopException
Gets the XML representation.- Parameters:
variables-- Returns:
- the XML representation of this pipeline
- Throws:
HopException- if any errors occur during generation of the XML- See Also:
IXml#getXml()
-
getCreatedDate
Date getCreatedDate()
Gets the date the pipeline was created.- Returns:
- the date the pipeline was created
-
setCreatedDate
void setCreatedDate(Date date)
Sets the date the pipeline was created.- Parameters:
date- The creation date to set
-
canSave
boolean canSave()
Returns whether or not the this can be saved.- Returns:
-
getCreatedUser
String getCreatedUser()
Gets the user by whom this was created.- Returns:
- the user by whom this was created
-
setCreatedUser
void setCreatedUser(String createduser)
Sets the user by whom this was created.- Parameters:
createduser- The user to set
-
getModifiedDate
Date getModifiedDate()
Gets the date this was modified.- Returns:
- the date this was modified
-
setModifiedDate
void setModifiedDate(Date date)
Sets the date this was modified.- Parameters:
date- The modified date to set
-
setModifiedUser
void setModifiedUser(String user)
Sets the user who last modified this.- Parameters:
user- The user name to set
-
getModifiedUser
String getModifiedUser()
Gets the user who last modified this.- Returns:
- the user who last modified this
-
getFilename
String getFilename()
Get the filename (if any).- Returns:
- the filename
-
setInternalHopVariables
void setInternalHopVariables(IVariables variables)
Sets the internal hop variables on the provided IVariables- Parameters:
variables- the variables to set the internal Hop variables and values on
-
isNameSynchronizedWithFilename
boolean isNameSynchronizedWithFilename()
- Returns:
- true if the name is derived from the filename
-
setNameSynchronizedWithFilename
void setNameSynchronizedWithFilename(boolean nameSynchronizedWithFilename)
- Parameters:
nameSynchronizedWithFilename- Set to true if the name is derived from the filename
-
-