Package org.pentaho.di.trans.steps.gettablenames

Class GetTableNamesMeta

java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.step.BaseDatabaseStepMeta
org.pentaho.di.trans.steps.gettablenames.GetTableNamesMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface
public class GetTableNamesMeta extends BaseDatabaseStepMeta implements StepMetaInterface

  • Constructor Details

    • GetTableNamesMeta

      public GetTableNamesMeta()

  • Method Details

    • getDatabaseMeta

      public org.pentaho.di.core.database.DatabaseMeta getDatabaseMeta()
      Specified by:
      getDatabaseMeta in class BaseDatabaseStepMeta
      Returns:
      Returns the database.

    • setDatabaseMeta

      public void setDatabaseMeta(org.pentaho.di.core.database.DatabaseMeta database)
      Parameters:
      database - The database to set.

    • getTablenameFieldName

      public String getTablenameFieldName()
      Returns:
      Returns the resultName.

    • setTablenameFieldName

      public void setTablenameFieldName(String tablenamefieldname)
      Parameters:
      tablenamefieldname - The tablenamefieldname to set.

    • getSQLCreationFieldName

      public String getSQLCreationFieldName()
      Returns:
      Returns the resultName.

    • setSQLCreationFieldName

      public void setSQLCreationFieldName(String sqlcreationfieldname)
      Parameters:
      sqlcreationfieldname - The sqlcreationfieldname to set.

    • getSchemaName

      public String getSchemaName()
      Returns:
      Returns the resultName.

    • setSchemaName

      public void setSchemaName(String schemaname)
      Parameters:
      schemaname - The schemaname to set.

    • setObjectTypeFieldName

      public void setObjectTypeFieldName(String objecttypefieldname)
      Parameters:
      objecttypefieldname - The objecttypefieldname to set.

    • setIsSystemObjectFieldName

      public void setIsSystemObjectFieldName(String issystemobjectfieldname)
      Parameters:
      issystemobjectfieldname - The issystemobjectfieldname to set.

    • setSystemObjectFieldName

      public void setSystemObjectFieldName(String issystemobjectfieldname)

    • getObjectTypeFieldName

      public String getObjectTypeFieldName()
      Returns:
      Returns the objecttypefieldname.

    • isSystemObjectFieldName

      public String isSystemObjectFieldName()
      Returns:
      Returns the issystemobjectfieldname.

    • getSchemaFieldName

      public String getSchemaFieldName()
      Returns:
      Returns the schenameNameField.

    • setSchemaFieldName

      public void setSchemaFieldName(String schemaNameField)
      Parameters:
      schenameNameField - The schemaNameField to set.

    • setIncludeTable

      public void setIncludeTable(boolean includetable)

    • isIncludeTable

      public boolean isIncludeTable()

    • setIncludeSchema

      public void setIncludeSchema(boolean includeSchema)

    • isIncludeSchema

      public boolean isIncludeSchema()

    • setIncludeCatalog

      public void setIncludeCatalog(boolean includeCatalog)

    • isIncludeCatalog

      public boolean isIncludeCatalog()

    • setIncludeView

      public void setIncludeView(boolean includeView)

    • isIncludeView

      public boolean isIncludeView()

    • setIncludeProcedure

      public void setIncludeProcedure(boolean includeProcedure)

    • isIncludeProcedure

      public boolean isIncludeProcedure()

    • setIncludeSynonym

      public void setIncludeSynonym(boolean includeSynonym)

    • isIncludeSynonym

      public boolean isIncludeSynonym()

    • setDynamicSchema

      public void setDynamicSchema(boolean dynamicSchema)

    • isDynamicSchema

      public boolean isDynamicSchema()

    • setAddSchemaInOut

      public void setAddSchemaInOut(boolean addSchemaInOutput)

    • isAddSchemaInOut

      public boolean isAddSchemaInOut()

    • setConnection

      public void setConnection(String connectionName)

    • loadXML

      public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException
      Description copied from interface: StepMetaInterface
      Load the values for this step from an XML Node
      Specified by:
      loadXML in interface StepMetaInterface
      Overrides:
      loadXML in class BaseStepMeta
      Parameters:
      stepnode - the Node to get the info from
      databases - The available list of databases to reference to
      metaStore - the metastore to optionally load external reference metadata from
      Throws:
      org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

    • clone

      public Object clone()
      Description copied from interface: StepMetaInterface
      Make an exact copy of this step, make sure to explicitly copy Collections etc.
      Specified by:
      clone in interface StepMetaInterface
      Overrides:
      clone in class BaseStepMeta
      Returns:
      an exact copy of this step

    • setDefault

      public void setDefault()
      Description copied from interface: StepMetaInterface
      Set default values
      Specified by:
      setDefault in interface StepMetaInterface

    • getFields

      public void getFields(org.pentaho.di.core.row.RowMetaInterface r, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleStepException
      Description copied from class: BaseStepMeta
      Gets the fields.
      Specified by:
      getFields in interface StepMetaInterface
      Overrides:
      getFields in class BaseStepMeta
      Parameters:
      r - the input row meta that is modified in this method to reflect the output row metadata of the step
      name - Name of the step to use as input for the origin field in the values
      info - Fields used as extra lookup information
      nextStep - the next step that is targeted
      space - the space The variable space to use to replace variables
      repository - the repository to use to load Kettle metadata objects impacting the output fields
      metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields
      Throws:
      org.pentaho.di.core.exception.KettleStepException - the kettle step exception

    • getXML

      public String getXML()
      Description copied from class: BaseStepMeta
      Produces the XML string that describes this step's information.
      Specified by:
      getXML in interface StepMetaInterface
      Overrides:
      getXML in class BaseStepMeta
      Returns:
      String containing the XML describing this step.

    • readRep

      public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: StepMetaInterface
      Read the steps information from a Kettle repository
      Specified by:
      readRep in interface StepMetaInterface
      Overrides:
      readRep in class BaseStepMeta
      Parameters:
      rep - The repository to read from
      metaStore - The MetaStore to read external information from
      id_step - The step ID
      databases - The databases to reference
      Throws:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • saveRep

      public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: StepMetaInterface
      Save the steps data into a Kettle repository
      Specified by:
      saveRep in interface StepMetaInterface
      Overrides:
      saveRep in class BaseStepMeta
      Parameters:
      rep - The Kettle repository to save to
      metaStore - the metaStore to optionally write to
      id_transformation - The transformation ID
      id_step - The step ID
      Throws:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
      Description copied from interface: StepMetaInterface
      Checks the settings of this step and puts the findings in a remarks List.
      Specified by:
      check in interface StepMetaInterface
      Overrides:
      check in class BaseStepMeta
      Parameters:
      remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
      stepMeta - The stepMeta to help checking
      prev - The fields coming from the previous step
      input - The input step names
      output - The output step names
      info - The fields that are used as information by the step
      space - the variable space to resolve variable expressions with
      repository - the repository to use to load Kettle metadata objects impacting the output fields
      metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

    • getStep

      public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
      Description copied from interface: StepMetaInterface
      Get the executing step, needed by Trans to launch a step.
      Specified by:
      getStep in interface StepMetaInterface
      Parameters:
      stepMeta - The step info
      stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
      cnr - The copy nr to get
      transMeta - The transformation info
      trans - The launching transformation

    • getStepData

      public StepDataInterface getStepData()
      Description copied from interface: StepMetaInterface
      Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.
      Specified by:
      getStepData in interface StepMetaInterface
      Returns:
      The appropriate StepDataInterface class.

    • getUsedDatabaseConnections

      public org.pentaho.di.core.database.DatabaseMeta[] getUsedDatabaseConnections()
      Description copied from class: BaseStepMeta
      This method returns all the database connections that are used by the step.
      Specified by:
      getUsedDatabaseConnections in interface StepMetaInterface
      Overrides:
      getUsedDatabaseConnections in class BaseStepMeta
      Returns:
      an array of database connections meta-data. Return an empty array if no connections are used.

    • supportsErrorHandling

      public boolean supportsErrorHandling()
      Specified by:
      supportsErrorHandling in interface StepMetaInterface
      Overrides:
      supportsErrorHandling in class BaseStepMeta
      Returns:
      true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.