Package org.gephi.graph.api

Interface Column

  • public interface Column
    A column belongs to a table and represent a dimension in the data.

    A column has primarily a unique identifier and a type, which both are set at the creation time.

    See Also:
    Table

    • Method Detail

      • getId

        String getId()
        Returns the column id, a unique identifier.
        Returns:
        the column's identifier

      • getIndex

        int getIndex()
        Returns the column's integer index, which is the position of the column in the store.
        Returns:
        the column's index

      • getTitle

        String getTitle()
        Returns the column's title.
        Returns:
        the column title

      • getTypeClass

        Class getTypeClass()
        Returns the column's type.
        Returns:
        the column type

      • getOrigin

        Origin getOrigin()
        Returns the column's data origin.
        Returns:
        the column origin

      • getEstimator

        Estimator getEstimator()
        Returns the estimator for this column
        Returns:
        the estimator, or null if not set

      • getTable

        Table getTable()
        Returns the table this column belong to.
        Returns:
        the table

      • isIndexed

        boolean isIndexed()
        Returns true if this column is indexed.
        Returns:
        true if indexed, false otherwise

      • isArray

        boolean isArray()
        Returns true if this column has an array type.
        Returns:
        true if array type, false otherwise

      • isDynamic

        boolean isDynamic()
        Returns true if this column has a dynamic type.
        Returns:
        true if dynamic type, false otherwise

      • isDynamicAttribute

        boolean isDynamicAttribute()
        Returns true if this column is dynamic and has a TimeMap type.
        Returns:
        true if dynamic attribute type, false otherwise

      • isNumber

        boolean isNumber()
        Returns true if this column has a number type.
        Returns:
        true if number type, false otherwise

      • exists

        boolean exists()
        Returns true if this column exists and belong to a table.
        Returns:
        true if exists, false otherwise

      • isProperty

        boolean isProperty()
        Returns true if this column is a property.

        This is equivalent to test if the column's origin is Origin.PROPERTY

        Returns:
        true if property, false otherwise

      • isReadOnly

        boolean isReadOnly()
        Returns true if this column is read-only.
        Returns:
        true if read-only, false otherwise

      • getDefaultValue

        Object getDefaultValue()
        Returns the column's default value, or null if not set.
        Returns:
        the default value, or null

      • setEstimator

        void setEstimator​(Estimator estimator)
        Sets the estimator for this column.
        Parameters:
        estimator - the estimator to set

      • createColumnObserver

        ColumnObserver createColumnObserver​(boolean withDiff)
        Create a new column observer.
        Parameters:
        withDiff - true if column observer should provide column differences
        Returns:
        the column observer