Package com.priint.pubserver.plugin.entitydata

Class TableData

    • Method Detail

      • getGroupIdentifier

        public java.lang.String getGroupIdentifier()
        String key for grouping tables of the same type.
        Returns:
        group identifier or empty string

      • setGroupIdentifier

        public void setGroupIdentifier​(java.lang.String groupIdentifier)
        Parameters:
        groupIdentifier - see getGroupIdentifier()

      • getLabel

        public java.lang.String getLabel()
        Display label for the table.
        Returns:
        label or empty string

      • setLabel

        public void setLabel​(java.lang.String label)
        Parameters:
        label - see getLabel()

      • getVersion

        public java.lang.String getVersion()
        Version string from the content system
        Returns:
        version or empty string

      • setVersion

        public void setVersion​(java.lang.String version)
        Parameters:
        version - see getVersion()

      • getTimestamp

        public java.lang.String getTimestamp()
        Get timestamp from the content system.

        Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.

        Returns:
        timestamp or empty string

      • setTimestamp

        public void setTimestamp​(java.lang.String timestamp)
        Parameters:
        timestamp - see getTimestamp()

      • getTemplate

        public java.lang.String getTemplate()
        Returns:
        String identifier of the template to render this content - empty string if not set.

      • setTemplate

        public void setTemplate​(java.lang.String template)
        Parameters:
        template - getTemplate()

      • getSequence

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

        This should reflect the position of the current table in the sorting of tables of its parent bucket.

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

      • setSequence

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

      • getCreatedBy

        public java.lang.String getCreatedBy()
        Returns:
        creation user or empty string

      • setCreatedBy

        public void setCreatedBy​(java.lang.String createdBy)
        Parameters:
        createdBy - see getCreatedBy()

      • getCreatedOn

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

      • setCreatedOn

        public void setCreatedOn​(java.util.Date createdOn)
        Parameters:
        createdOn - see getCreatedOn()

      • getUpdatedBy

        public java.lang.String getUpdatedBy()
        Returns:
        last modified user or empty string

      • setUpdatedBy

        public void setUpdatedBy​(java.lang.String updatedBy)
        Parameters:
        updatedBy - see getUpdatedBy()

      • getUpdatedOn

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

      • setUpdatedOn

        public void setUpdatedOn​(java.util.Date updatedOn)
        Parameters:
        updatedOn - see getUpdatedOn()

      • getConnectorEntity

        public ConnectorEntity getConnectorEntity()
        Returns:
        connector entity object or null if not set

      • getEntityTableDataId

        public java.lang.String getEntityTableDataId()
        Returns:
        String identifier of the tableData entity in the related entity model, e.g. "Description". Or empty string.

      • setEntityTableDataId

        public void setEntityTableDataId​(java.lang.String entityTableDataId)
        Parameters:
        entityTableDataId - getEntityTableDataId()

      • getBucket

        public Bucket getBucket()
        Returns:
        Parent bucket that this table is related to or null.

      • setBucket

        public void setBucket​(Bucket bucket)
        Parameters:
        bucket - getBucket()

      • getBucketId

        public java.lang.String getBucketId()
        Returns:
        Identifier of parent bucket that this table element is related to. Id is not loaded by Entity Manager in its standard methods. Take id from {@link #getBucket())}.

      • setBucketId

        public void setBucketId​(java.lang.String bucketId)
        Parameters:
        bucketId - getBucketId()

      • getTableDataRows

        public java.util.List<TableDataRow> getTableDataRows()
        Returns:
        List of all rows related to the table - or empty list.

        List is LAZY loaded.

      • getMetaData

        public java.util.List<KeyValue> getMetaData()
        Returns:
        List of meta data related to the table or empty list.

        List is LAZY loaded.

      • setMetaData

        public void setMetaData​(java.util.List<KeyValue> metaData)
        Parameters:
        metaData - see getMetaData()

      • getCellWidth

        public float getCellWidth()
        Returns:
        Default width of the cell

        Default format is millimeter for comet and pixel for HTML.

        Default value is 10.0.

      • setCellWidth

        public void setCellWidth​(float cellWidth)
        Parameters:
        cellWidth - getCellWidth()

      • getCellHeight

        public float getCellHeight()
        Returns:
        Default height of the cell

        Default format is millimeter for comet and pixel for HTML.

        Default value is 1.058.

      • setCellHeight

        public void setCellHeight​(float cellHeight)
        Parameters:
        cellHeight - getCellHeight()

      • getTableStyle

        public java.lang.String getTableStyle()
        Returns:
        name of table style or an empty string

      • setTableStyle

        public void setTableStyle​(java.lang.String tableStyle)
        Parameters:
        tableStyle - getTableStyle()

      • getHeaderRows

        public int getHeaderRows()
        Returns:
        number of header rows

        Caution: This might be greater than actual row count in a table.

      • setHeaderRows

        public void setHeaderRows​(int headerRows)
        Parameters:
        headerRows - getHeaderRows()

      • getFooterRows

        public int getFooterRows()
        Returns:
        number of footer rows

        Caution: This might be greater than actual row count in a table.

      • setFooterRows

        public void setFooterRows​(int footerRows)
        Parameters:
        footerRows - getFooterRows()

      • getCellMaxHeight

        public float getCellMaxHeight()
        Returns:
        max height of the cell

        Default format is millimeter for comet and pixel for HTML.

      • setCellMaxHeight

        public void setCellMaxHeight​(float cellMaxHeight)
        Parameters:
        cellMaxHeight - getCellMaxHeight()

      • getLeftColumn

        public int getLeftColumn()
        Returns:
        number of left columns, i.e. columns using left column style

        Caution: This might be greater than actual cell count in a row.

      • setLeftColumn

        public void setLeftColumn​(int leftColumn)
        Parameters:
        leftColumn - getLeftColumn()

      • getCellStyleLeftColumn

        public java.lang.String getCellStyleLeftColumn()
        Returns:
        name of cell style of left column(s) or an empty string

      • setCellStyleLeftColumn

        public void setCellStyleLeftColumn​(java.lang.String cellStyleLeftColumn)
        Parameters:
        cellStyleLeftColumn - getCellStyleLeftColumn()

      • getRightColumn

        public int getRightColumn()
        Returns:
        number of right columns, i.e. columns using right column style

        Caution: This might be greater than actual cell count in a row.

      • setRightColumn

        public void setRightColumn​(int rightColumn)
        Parameters:
        rightColumn - getRightColumn()

      • getCellStyleRightColumn

        public java.lang.String getCellStyleRightColumn()
        Returns:
        name of cell style of right column(s) or an empty string

      • setCellStyleRightColumn

        public void setCellStyleRightColumn​(java.lang.String cellStyleRightColumn)
        Parameters:
        cellStyleRightColumn - getCellStyleRightColumn()

      • getMaxHeight

        public float getMaxHeight()

      • setMaxHeight

        public void setMaxHeight​(float maxHeight)

      • getCellMaxWidth

        public float getCellMaxWidth()

      • setCellMaxWidth

        public void setCellMaxWidth​(float cellMaxWidth)

      • getCell

        public TableDataCell getCell​(int row,
                             int col)
        Get a cell by row and col index.

        . This does not consider rowspan or colspan, so rows may have differing numbers of columns.

        Parameters:
        row - row index
        col - column index
        Returns:
        table data cell found or null

      • getOrigin

        public java.lang.String getOrigin()
        Returns:
        Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return null.

      • setOrigin

        public void setOrigin​(java.lang.String origin)
        Parameters:
        origin - getOrigin()

      • getEntityIdentifier

        public java.lang.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​(java.lang.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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getContentMetaData

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

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.