Package org.ametys.plugins.extraction.execution

Class Extraction

java.lang.Object
org.ametys.plugins.extraction.execution.Extraction
public class Extraction extends Object
Object representing the extraction definition file content

  • Constructor Details

    • Extraction

      public Extraction(String fileName)
      Constructor
      Parameters:
      fileName - The file name

  • Method Details

    • getFileName

      public String getFileName()
      Get the file name of this extraction
      Returns:
      the file name

    • getDescriptionId

      public String getDescriptionId()
      Retrieves the identifier of the extraction's description
      Returns:
      the identifier of the extraction's description

    • setDescriptionId

      public void setDescriptionId(String descriptionId)
      Set the identifier of the extraction's description
      Parameters:
      descriptionId - the identifier to set

    • getExtractionComponents

      public List<ExtractionComponent> getExtractionComponents()
      Retrieves the list of the extraction components
      Returns:
      The extraction components

    • addExtractionComponent

      public void addExtractionComponent(ExtractionComponent extractionComponent)
      Add an extraction component
      Parameters:
      extractionComponent - The extraction component to add

    • getDisplayOptionalColumnsNames

      public List<String> getDisplayOptionalColumnsNames()
      Retrieves the list of variables names controlling display of optional columns
      Returns:
      The variables names

    • setDisplayOptionalColumnsNames

      public void setDisplayOptionalColumnsNames(List<String> displayOptionalColumnsNames)
      Set variables names controlling display of optional columns
      Parameters:
      displayOptionalColumnsNames - the variables for the optional columns to set

    • getClausesVariables

      public List<Extraction.ClausesVariable> getClausesVariables()
      Retrieves the list of variables to use in clauses
      Returns:
      A List containing clauses variables

    • setClausesVariables

      public void setClausesVariables(List<Extraction.ClausesVariable> clausesVariables)
      Set variables to use in clauses
      Parameters:
      clausesVariables - A Map containing variables to set

    • getAuthor

      public UserIdentity getAuthor()
      Get the author of the extraction
      Returns:
      The author

    • setAuthor

      public void setAuthor(UserIdentity author)
      Set the author of this extraction.
      Parameters:
      author - the author