Package com.norconex.importer.handler.transformer.impl

Class ExternalTransformerConfig

java.lang.Object
com.norconex.importer.handler.BaseLabelableConfig
com.norconex.importer.handler.BaseDocHandlerConfig
com.norconex.importer.handler.transformer.impl.ExternalTransformerConfig
All Implemented Interfaces:
Labelable
public class ExternalTransformerConfig extends BaseDocHandlerConfig

  • Field Details

  • Constructor Details

    • ExternalTransformerConfig

      public ExternalTransformerConfig()

  • Method Details

    • getExtractionPatterns

      public List<RegexFieldValueExtractor> getExtractionPatterns()
      Gets metadata extraction patterns. See class documentation.
      Returns:
      extraction patterns

    • setExtractionPatterns

      public ExternalTransformerConfig setExtractionPatterns(List<RegexFieldValueExtractor> extractionPatterns)
      Sets metadata extraction patterns. See class documentation.
      Parameters:
      extractionPatterns - extraction pattern
      Returns:
      this instance

    • getCommand

      public String getCommand()
      The command to execute. Make sure to escape spaces in executable path and its arguments as well as other special command line characters.
      Returns:
      the command

    • getEnvironmentVariables

      public Map<String,String> getEnvironmentVariables()
      Sets the environment variables. Clearing any previously assigned environment variables. When null, uses the current process environment variables (default).
      Returns:
      environment variables or null if using the current process environment variables

    • getMetadataInputFormat

      public String getMetadataInputFormat()

    • getMetadataOutputFormat

      public String getMetadataOutputFormat()

    • getTempDir

      public Path getTempDir()
      The directory where to store temporary files sent to the external handler as file paths.
      Returns:
      temporary directory

    • getOnSet

      public PropertySetter getOnSet()
      Gets the property setter to use when a metadata value is set.
      Returns:
      property setter

    • setCommand

      public ExternalTransformerConfig setCommand(String command)
      The command to execute. Make sure to escape spaces in executable path and its arguments as well as other special command line characters.
      Parameters:
      command - the command
      Returns:
      this.

    • setEnvironmentVariables

      public ExternalTransformerConfig setEnvironmentVariables(Map<String,String> environmentVariables)
      Sets the environment variables. Clearing any previously assigned environment variables. When null, uses the current process environment variables (default).
      Parameters:
      environmentVariables - environment variables
      Returns:
      this.

    • setMetadataInputFormat

      public ExternalTransformerConfig setMetadataInputFormat(String metadataInputFormat)
      Returns:
      this.

    • setMetadataOutputFormat

      public ExternalTransformerConfig setMetadataOutputFormat(String metadataOutputFormat)
      Returns:
      this.

    • setTempDir

      public ExternalTransformerConfig setTempDir(Path tempDir)
      The directory where to store temporary files sent to the external handler as file paths.
      Parameters:
      tempDir - temporary directory
      Returns:
      this.

    • setOnSet

      public ExternalTransformerConfig setOnSet(PropertySetter onSet)
      Gets the property setter to use when a metadata value is set.
      Parameters:
      onSet - property setter
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseLabelableConfig

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseLabelableConfig

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseLabelableConfig

    • toString

      public String toString()
      Overrides:
      toString in class BaseLabelableConfig