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

  • Method Details

    • 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

    • getQueryVariablesNamesAndContentTypes

      public Map<String,String> getQueryVariablesNamesAndContentTypes()
      Retrieves the list of variables names and content type to use in queries
      Returns:
      A Map containing variables names and content types

    • setQueryVariablesNamesAndContentTypes

      public void setQueryVariablesNamesAndContentTypes(Map<String,String> queryVariablesNamesAndContentTypes)
      Set variables names and content types to use in queries
      Parameters:
      queryVariablesNamesAndContentTypes - A Map containing variables names and content types 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