Package org.pentaho.di.job.entries.copyfiles

Class JobEntryCopyFiles

  • All Implemented Interfaces:
    Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
    public class JobEntryCopyFiles
extends JobEntryBase
implements Cloneable, JobEntryInterface
    This defines a 'copy files' job entry.
    Since:
    06-05-2007
    Author:
    Samatar Hassan

    • Field Detail

      • copy_empty_folders

        public boolean copy_empty_folders

      • arg_from_previous

        public boolean arg_from_previous

      • overwrite_files

        public boolean overwrite_files

      • include_subfolders

        public boolean include_subfolders

      • add_result_filesname

        public boolean add_result_filesname

      • remove_source_files

        public boolean remove_source_files

      • destination_is_a_file

        public boolean destination_is_a_file

      • create_destination_folder

        public boolean create_destination_folder

      • source_filefolder

        public String[] source_filefolder

      • destination_filefolder

        public String[] destination_filefolder

      • wildcard

        public String[] wildcard

    • Constructor Detail

      • JobEntryCopyFiles

        public JobEntryCopyFiles​(String n)

      • JobEntryCopyFiles

        public JobEntryCopyFiles()

    • Method Detail

      • allocate

        public void allocate​(int nrFields)

      • clone

        public Object clone()
        Description copied from class: JobEntryBase
        This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.
        Specified by:
        clone in interface JobEntryInterface
        Overrides:
        clone in class JobEntryBase
        Returns:
        a clone of the object

      • getXML

        public String getXML()
        Description copied from class: JobEntryBase
        This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.
        Specified by:
        getXML in interface JobEntryInterface
        Overrides:
        getXML in class JobEntryBase
        Returns:
        the xml representation of the job entry

      • loadXML

        public void loadXML​(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.
        Specified by:
        loadXML in interface JobEntryInterface
        Overrides:
        loadXML in class JobEntryBase
        Parameters:
        entrynode - the top-level XML node
        databases - the list of databases
        slaveServers - the list of slave servers
        rep - the repository object
        metaStore - The metaStore to optionally load from.
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

      • loadSource

        protected String loadSource​(Node fnode)

      • loadDestination

        protected String loadDestination​(Node fnode)

      • saveDestination

        protected void saveDestination​(StringBuilder retval,
                               String destination)

      • loadSourceRep

        protected String loadSourceRep​(Repository rep,
                               org.pentaho.di.repository.ObjectId id_jobentry,
                               int a)
                        throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • loadDestinationRep

        protected String loadDestinationRep​(Repository rep,
                                    org.pentaho.di.repository.ObjectId id_jobentry,
                                    int a)
                             throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • saveSourceRep

        protected void saveSourceRep​(Repository rep,
                             org.pentaho.di.repository.ObjectId id_job,
                             org.pentaho.di.repository.ObjectId id_jobentry,
                             int i,
                             String value)
                      throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • saveDestinationRep

        protected void saveDestinationRep​(Repository rep,
                                  org.pentaho.di.repository.ObjectId id_job,
                                  org.pentaho.di.repository.ObjectId id_jobentry,
                                  int i,
                                  String value)
                           throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • loadRep

        public void loadRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
        Specified by:
        loadRep in interface JobEntryInterface
        Overrides:
        loadRep in class JobEntryBase
        Parameters:
        rep - the repository object
        metaStore - the MetaStore to use
        id_jobentry - the id of the job entry
        databases - the list of databases
        slaveServers - the list of slave servers
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the load

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
        Specified by:
        saveRep in interface JobEntryInterface
        Overrides:
        saveRep in class JobEntryBase
        Parameters:
        rep - the repository
        metaStore - the MetaStore to use
        id_job - the id_job
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the save

      • execute

        public org.pentaho.di.core.Result execute​(org.pentaho.di.core.Result previousResult,
                                          int nr)
                                   throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.
        Specified by:
        execute in interface JobEntryInterface
        Parameters:
        previousResult - the previous result
        nr - the number of rows
        Returns:
        the Result object from execution of this job entry
        Throws:
        org.pentaho.di.core.exception.KettleException - if any Kettle exceptions occur

      • setCopyEmptyFolders

        public void setCopyEmptyFolders​(boolean copy_empty_foldersin)

      • isCopyEmptyFolders

        public boolean isCopyEmptyFolders()

      • setoverwrite_files

        public void setoverwrite_files​(boolean overwrite_filesin)

      • isoverwrite_files

        public boolean isoverwrite_files()

      • setIncludeSubfolders

        public void setIncludeSubfolders​(boolean include_subfoldersin)

      • isIncludeSubfolders

        public boolean isIncludeSubfolders()

      • setAddresultfilesname

        public void setAddresultfilesname​(boolean add_result_filesnamein)

      • isAddresultfilesname

        public boolean isAddresultfilesname()

      • setArgFromPrevious

        public void setArgFromPrevious​(boolean argfrompreviousin)

      • isArgFromPrevious

        public boolean isArgFromPrevious()

      • setRemoveSourceFiles

        public void setRemoveSourceFiles​(boolean remove_source_filesin)

      • isRemoveSourceFiles

        public boolean isRemoveSourceFiles()

      • setDestinationIsAFile

        public void setDestinationIsAFile​(boolean destination_is_a_file)

      • isDestinationIsAFile

        public boolean isDestinationIsAFile()

      • setCreateDestinationFolder

        public void setCreateDestinationFolder​(boolean create_destination_folder)

      • isCreateDestinationFolder

        public boolean isCreateDestinationFolder()

      • check

        public void check​(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
        Description copied from class: JobEntryBase
        Allows JobEntry objects to check themselves for consistency
        Specified by:
        check in interface JobEntryInterface
        Overrides:
        check in class JobEntryBase
        Parameters:
        remarks - List of CheckResult objects indicating consistency status
        jobMeta - the metadata object for the job entry
        space - the variable space to resolve string expressions with variables with
        repository - the repository to load Kettle objects from
        metaStore - the MetaStore to load common elements from

      • evaluates

        public boolean evaluates()
        Description copied from class: JobEntryBase
        This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false
        Specified by:
        evaluates in interface JobEntryInterface
        Overrides:
        evaluates in class JobEntryBase
        Returns:
        false

      • setConfigurationMappings

        public void setConfigurationMappings​(Map<String,​String> mappings)

      • getConfigurationBy

        public String getConfigurationBy​(String url)

      • getUrlPath

        public String getUrlPath​(String incomingURL)