Package com.northconcepts.datapipeline.excel

Class ExcelFieldMetadata

java.lang.Object
com.northconcepts.datapipeline.excel.ExcelFieldMetadata
public final class ExcelFieldMetadata extends Object
Provides access to Excel-specific metadata attached to a Field. This class allows getting and setting ExcelHyperlink and ExcelCellStyle properties on a field via session properties.
See Also:

  • Constructor Details

    • ExcelFieldMetadata

      public ExcelFieldMetadata()
      Creates a new ExcelFieldMetadata with no associated field.

    • ExcelFieldMetadata

      public ExcelFieldMetadata(Field field)
      Creates a new ExcelFieldMetadata for the specified field.
      Parameters:
      field - the field to attach metadata to

  • Method Details

    • getField

      public Field getField()
      Gets the field associated with this metadata.
      Returns:
      the field

    • setField

      public ExcelFieldMetadata setField(Field field)
      Sets the field for this metadata.
      Parameters:
      field - the field to set
      Returns:
      this ExcelFieldMetadata instance for method chaining

    • getExcelHyperlink

      public ExcelHyperlink getExcelHyperlink()
      Gets the ExcelHyperlink attached to the field, if any.
      Returns:
      the ExcelHyperlink, or null if none is set

    • setExcelHyperlink

      public ExcelFieldMetadata setExcelHyperlink(ExcelHyperlink excelHyperlink)
      Attaches an ExcelHyperlink to the field as a session property.
      Parameters:
      excelHyperlink - the hyperlink to attach
      Returns:
      this ExcelFieldMetadata instance for method chaining

    • getExcelCellStyle

      public ExcelCellStyle getExcelCellStyle()
      Gets the ExcelCellStyle attached to the field, if any.
      Returns:
      the ExcelCellStyle, or null if none is set

    • setExcelCellStyle

      public ExcelFieldMetadata setExcelCellStyle(ExcelCellStyle cellStyle)
      Attaches an ExcelCellStyle to the field as a session property.
      Parameters:
      cellStyle - the cell style to attach
      Returns:
      this ExcelFieldMetadata instance for method chaining