Package com.priint.pubserver.plugin.entitydata

Class TableDataCell

java.lang.Object
com.priint.pubserver.plugin.entitydata.TableDataCell
All Implemented Interfaces:
GetIdentifier, GetSequence, EntityData, PersistentData, Serializable, Comparable<TableDataCell>
@Entity public class TableDataCell extends Object implements Serializable, GetIdentifier, GetSequence, EntityData, PersistentData, Comparable<TableDataCell>
TableDataCell represents a table cell in a TableData object and is connected to a row.

TableDataCell is a cell representation optimized for comet output scenarios. It may also be used to represent table data for HTML output.

Since:
4.0.0, 4.0.5 added JPA annotations
See Also:

  • Constructor Details

  • Method Details

    • getIdentifier

      public String getIdentifier()
      Get the string identifier of the cell.
      Specified by:
      getIdentifier in interface EntityData
      Specified by:
      getIdentifier in interface GetIdentifier
      Specified by:
      getIdentifier in interface PersistentData
      Returns:
      identifier string or null if not set

    • setIdentifier

      public void setIdentifier(String identifier)
      Specified by:
      setIdentifier in interface EntityData
      Parameters:
      identifier - see getIdentifier()

    • getTableRow

      public TableDataRow getTableRow()

    • setTableRow

      public void setTableRow(TableDataRow tableRow)

    • getColspan

      public int getColspan()
      Returns:
      Number of columns that this cell spans.

    • setColspan

      public void setColspan(int colspan)
      Parameters:
      colspan - getColspan()

    • getRowspan

      public int getRowspan()
      Returns:
      Number of rows that this cell spans.

    • setRowspan

      public void setRowspan(int rowspan)
      Parameters:
      rowspan - getRowspan()

    • getCellStyle

      public String getCellStyle()
      Returns:
      name of cell style or an empty string

    • setCellStyle

      public void setCellStyle(String cellStyle)
      Parameters:
      cellStyle - getCellStyle()

    • getWidth

      public float getWidth()
      Returns:
      Width of the cell.

      Comet: millimeter, HTML: pixel.

      Default is "0" meaning not explicitly set.

    • setWidth

      public void setWidth(float width)
      Parameters:
      width - getWidth()

    • getHeight

      public float getHeight()
      Returns:
      Height of the cell.

      Comet: millimeter, HTML: pixel.

      Default is "0" meaning not explicitly set.

    • setHeight

      public void setHeight(float height)
      Parameters:
      height - getHeight()

    • getValue

      public String getValue()
      Returns:
      Initial content of the cell.

      Might be overwritten by placeholder.

    • setValue

      public void setValue(String value)
      Parameters:
      value - getValue()

    • getPlaceholder

      public String getPlaceholder()
      Returns:
      Placeholder for reloading the content of the cell.

    • setPlaceholder

      public void setPlaceholder(String placeholder)
      Parameters:
      placeholder - getPlaceholder()

    • getPlaceholderType

      public String getPlaceholderType()
      Returns:
      placeholderType is one of TableDataCell.PlaceholderType

    • setPlaceholderType

      public void setPlaceholderType(String placeholderType)
      Parameters:
      placeholderType - getPlaceholderType()

    • getObjectIdentifier

      public String getObjectIdentifier()
      Returns:
      Id of the object that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setObjectIdentifier

      public void setObjectIdentifier(String objectIdentifier)
      Parameters:
      objectIdentifier - getObjectIdentifier()

    • getObjectGroupIdentifier

      public String getObjectGroupIdentifier()
      Returns:
      GroupId of the object that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setObjectGroupIdentifier

      public void setObjectGroupIdentifier(String objectGroupIdentifier)
      Parameters:
      objectGroupIdentifier - getObjectGroupIdentifier()

    • getObjectEntityId

      public String getObjectEntityId()
      Returns:
      EntityId of the object that is linked to the cell. In comet the placeholder needs this to create a comet StringID.

    • setObjectEntityId

      public void setObjectEntityId(String objectEntityId)
      Parameters:
      objectEntityId - getObjectEntityId()

    • getObjectEntityClass

      public String getObjectEntityClass()
      Returns:
      EntityClass of the object that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setObjectEntityClass

      public void setObjectEntityClass(String objectEntityClass)
      Parameters:
      objectEntityClass - getObjectEntityClass()

    • getParentIdentifier

      public String getParentIdentifier()
      Returns:
      Id of the parent that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setParentIdentifier

      public void setParentIdentifier(String parentIdentifier)
      Parameters:
      parentIdentifier - getParentIdentifier()

    • getParentGroupIdentifier

      public String getParentGroupIdentifier()
      Returns:
      GroupId of the parent that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setParentGroupIdentifier

      public void setParentGroupIdentifier(String parentGroupIdentifier)
      Parameters:
      parentGroupIdentifier - getParentGroupIdentifier()

    • getParentEntityId

      public String getParentEntityId()
      Returns:
      EntityId of the parent that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setParentEntityId

      public void setParentEntityId(String parentEntityId)
      Parameters:
      parentEntityId - getParentEntityId()

    • getParentEntityClass

      public String getParentEntityClass()
      Returns:
      EntityClass of the parent that is linked to the cell.

      In comet the placeholder needs this to create a comet StringID.

    • setParentEntityClass

      public void setParentEntityClass(String parentEntityClass)
      Parameters:
      parentEntityClass - getParentEntityClass()

    • getPlaceholderAutoLoad

      @Deprecated public int getPlaceholderAutoLoad()
      Deprecated.
      the "placeholderAutoload" flag is never evaluated. it stays here for backward compatibility.
      Returns:
      autoload flag of placeholder

    • setPlaceholderAutoLoad

      @Deprecated public void setPlaceholderAutoLoad(int placeholderAutoLoad)
      Deprecated.
      the "placeholderAutoload" flag is never evaluated. it stays here for backward compatibility.
      Parameters:
      placeholderAutoLoad - getPlaceholderAutoLoad()

    • getPlaceholderInlineHeight

      public float getPlaceholderInlineHeight()
      Returns:
      placeholderInlineHeight

    • setPlaceholderInlineHeight

      public void setPlaceholderInlineHeight(float placeholderInlineHeight)
      Parameters:
      placeholderInlineHeight - getPlaceholderInlineHeight()

    • getPlaceholderInlineWidth

      public float getPlaceholderInlineWidth()
      Returns:
      placeholderInlineWidth

    • setPlaceholderInlineWidth

      public void setPlaceholderInlineWidth(float placeholderInlineWidth)
      Parameters:
      placeholderInlineWidth - getPlaceholderInlineWidth()

    • getPlaceholderInlinePlacement

      public int getPlaceholderInlinePlacement()
      Returns:
      placeholderInlinePlacement

    • setPlaceholderInlinePlacement

      public void setPlaceholderInlinePlacement(int placeholderInlinePlacement)
      Parameters:
      placeholderInlinePlacement - getPlaceholderInlinePlacement()

    • getCreatedBy

      public String getCreatedBy()
      Returns:
      creation user or null if not set

    • setCreatedBy

      public void setCreatedBy(String createdBy)
      Parameters:
      createdBy - see getCreatedBy()

    • getCreatedOn

      public Date getCreatedOn()
      Returns:
      creation date or null if not set

    • setCreatedOn

      public void setCreatedOn(Date createdOn)
      Parameters:
      createdOn - see getCreatedOn()

    • getUpdatedBy

      public String getUpdatedBy()
      Returns:
      last modified user or null if not set

    • setUpdatedBy

      public void setUpdatedBy(String updatedBy)
      Parameters:
      updatedBy - see getUpdatedBy()

    • getUpdatedOn

      public Date getUpdatedOn()
      Returns:
      last modified date or null if not set

    • setUpdatedOn

      public void setUpdatedOn(Date updatedOn)
      Parameters:
      updatedOn - see getUpdatedOn()

    • getMaxHeight

      public float getMaxHeight()
      Returns:
      Maximum height of the cell.

      Comet: millimeter, HTML: pixel.

      Default is "0" meaning not explicitly set.

    • setMaxHeight

      public void setMaxHeight(float maxHeight)
      Parameters:
      maxHeight - getMaxHeight()

    • getMetaData

      public List<KeyValue> getMetaData()
      Returns:
      List of meta data related to the cell or empty list

    • setMetaData

      public void setMetaData(List<KeyValue> metaData)
      Parameters:
      metaData - see getMetaData()

    • getTableData

      public TableData getTableData()
      Returns:
      table data this cell is part of

    • setTableData

      public void setTableData(TableData tableData)
      Parameters:
      tableData - getTableData()

    • getTableDataId

      public String getTableDataId()
      Returns:
      Identifier of the table this cell is part of.

    • setTableDataId

      public void setTableDataId(String tableDataId)
      Parameters:
      tableDataId - getTableDataId()

    • getParagraphStyle

      public String getParagraphStyle()
      Returns:
      name of paragraph style for the cell or an empty string

    • setParagraphStyle

      public void setParagraphStyle(String paragraphStyle)
      Parameters:
      paragraphStyle - getParagraphStyle()

    • getCharacterStyle

      public String getCharacterStyle()
      Returns:
      name of character style for the cell or an empty string

    • setCharacterStyle

      public void setCharacterStyle(String characterStyle)
      Parameters:
      characterStyle - getCharacterStyle()

    • getSequence

      public int getSequence()
      Get sequence number for the cell as given in the content system.

      This should reflect the position of the current cell in the sorting of cells of its row.

      Specified by:
      getSequence in interface GetSequence
      Returns:
      ordered position within a list sequenceable objects

    • setSequence

      public void setSequence(int sequence)
      Parameters:
      sequence - see getSequence()

    • getLabel

      public String getLabel()
      Display label for the cell.
      Returns:
      label or null if not set

    • setLabel

      public void setLabel(String label)
      Parameters:
      label - see getLabel()

    • getPlaceholderInfo1

      public String getPlaceholderInfo1()

    • setPlaceholderInfo1

      public void setPlaceholderInfo1(String placeholderInfo1)

    • getPlaceholderInfo2

      public String getPlaceholderInfo2()

    • setPlaceholderInfo2

      public void setPlaceholderInfo2(String placeholderInfo2)

    • compareTo

      public int compareTo(TableDataCell compareObject)
      Two cells are compared using their sequence property.
      Specified by:
      compareTo in interface Comparable<TableDataCell>
      See Also:

    • getEntityIdentifier

      public String getEntityIdentifier()
      Description copied from interface: EntityData
      Identifier of an entity in the entity model where the current object refers to.
      Specified by:
      getEntityIdentifier in interface EntityData
      Returns:
      entity identifier as string

    • setEntityIdentifier

      public void setEntityIdentifier(String entityIdentifier)
      Description copied from interface: EntityData
      Identifier of an entity in the entity model where the current object refers to.
      Specified by:
      setEntityIdentifier in interface EntityData

    • getContext

      public Context getContext()
      Specified by:
      getContext in interface EntityData
      Returns:
      entity context

    • setContext

      public void setContext(Context context)
      Description copied from interface: EntityData
      set the context of entity data object
      Specified by:
      setContext in interface EntityData

    • getContentMetaData

      public List<ContentMetaData> getContentMetaData()
      Returns:
      List of ContentMetaData related to Bucket

    • setContentMetaData

      public void setContentMetaData(List<ContentMetaData> contentMetaData)
      Parameters:
      contentMetaData - getContentMetaData()