Package cdc.impex.templates

Class SheetTemplate

java.lang.Object
cdc.impex.templates.SheetTemplate
public final class SheetTemplate extends Object
Description of a sheet template.

It always has an optional action column.

Author:
Damien Carbonne

  • Field Details

  • Method Details

    • getDomain

      public String getDomain()
      Returns:
      The template domain.

    • getName

      public String getName()
      Returns:
      The template name.

    • getQName

      public String getQName()
      Returns:
      The template qualified name (domain.name).

    • getDescription

      public String getDescription()
      Returns:
      The template description.

    • getDefaultAction

      public ImportAction getDefaultAction()
      Returns:
      The default import action, used when action is not defined.

    • getActionColumnName

      public String getActionColumnName()
      Returns:
      The name of the action column.

    • getActionColumn

      public ColumnTemplate<ImportAction> getActionColumn()
      Returns:
      The action column

    • isActionColumn

      public boolean isActionColumn(ColumnTemplate<?> column)

    • getColumns

      public List<ColumnTemplate<?>> getColumns()
      Returns:
      The template columns.

    • getColumns

      public List<ColumnTemplate<?>> getColumns(Usage usage)

    • getHeader

      public cdc.office.tables.Header getHeader()
      Returns:
      The header.

    • hasPatterns

      public boolean hasPatterns()
      Returns:
      true if this sheet template contains pattern columns.

    • getColumnHeaders

      @Deprecated(forRemoval=true, since="2024-07-13") public List<cdc.office.tables.HeaderCell> getColumnHeaders()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The template column headers.

    • getColumnHeaders

      public List<cdc.office.tables.HeaderCell> getColumnHeaders(Usage usage)
      Returns a list of column headers that match a usage.
      Parameters:
      usage - The usage.
      Returns:
      A list of column headers that match usage.

    • getColumn

      public ColumnTemplate<?> getColumn(cdc.office.tables.HeaderCell header)
      Parameters:
      header - The cell header.
      Returns:
      The template associated to header.
      Throws:
      IllegalArgumentException - When header is null.
      NoSuchElementException - When there is no associated template.

    • getColumn

      public ColumnTemplate<?> getColumn(String name)
      Returns the column that has a given name.
      Parameters:
      name - The name.
      Returns:
      The column that is named name.
      Throws:
      IllegalArgumentException - When name is null.
      NoSuchElementException - When there is no column named name.

    • containsColumn

      public boolean containsColumn(String name)
      Returns true if this sheet template contains a column with a particular name.

      WARNING: This only works for name columns.

      Parameters:
      name - The name.
      Returns:
      true if this sheet template contains a column names name.

    • getMatchingColumn

      public ColumnTemplate<?> getMatchingColumn(String name)
      Parameters:
      name - The actual name.
      Returns:
      The column that matches name.
      Throws:
      NoSuchElementException - When there is not a single column matching name.

    • containsMatchingColumn

      public boolean containsMatchingColumn(String name)
      Parameters:
      name - The actual name.
      Returns:
      true when there a single column matching name.

    • instantiate

      public SheetTemplateInstance instantiate(List<String> patternReplacement)
      Parameters:
      patternReplacement - The list of names that must be used as actual columns names for pattern columns.
      Returns:
      A new SheetTemplateInstance whose template is this object and header is built from names of name columns and substitutions for pattern columns.

    • instantiate

      public SheetTemplateInstance instantiate(String... patternReplacement)
      Parameters:
      patternReplacement - The array of names that must be used as actual columns names for pattern columns.
      Returns:
      A new SheetTemplateInstance whose template is this object and header is built from names of name columns and substitutions for pattern columns.

    • newBuilder

      public SheetTemplate.Builder newBuilder()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static SheetTemplate.Builder builder()

    • builder

      public static SheetTemplate.Builder builder(SheetTemplate model)