org.gephi.data.attributes.api

Interface AttributeColumn

public interface AttributeColumn

Column is the header of a data column. It belongs to an AttributeTable and is the key to access data within AttributeRow.

It contains its index that may be used to get the appropriate value in the AttributeRow values array.

For Gephi internal implementation purposes, names of columns are restricted. They can have any name except these defined in PropertiesColumn enum.

Iterate rows values

 Attribute row = ...;
 for(AttributeColumn column : table.getColumns()) {
      Object value = row.getValue(column);
 }
 

Author:

Mathieu Bastian, Martin Škurla

See Also:

AttributeRow, AttributeTable

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue() Returns the default value for this column.
String	getId() Returns the id of this column.
int	getIndex() Returns the index of this column.
AttributeOrigin	getOrigin() Returns the origin of this column content, meta-data that describes where the column comes from.
AttributeValueDelegateProvider	getProvider() Returns the attribute value delegate provider.
AttributeTable	getTable() Returns the table that contains this column
String	getTitle() Returns the title of this column.
AttributeType	getType() Returns the type of this column content.

Method Detail

getType

AttributeType getType()

Returns the type of this column content.

Returns:

the type of this column

getTitle

String getTitle()

Returns the title of this column. The title is a human-readable text that describes the column data. When no title exists, returns the Id of this column.

Returns:

the title of this column, if exists, or the Id otherwise

getIndex

int getIndex()

Returns the index of this column. The index is the fastest way to access a column from its AttributeTable or manipulate AttributeRow.

Returns:

the index of this column

See Also:

AttributeTable.getColumn(int), AttributeRow.getValue(int)

getOrigin

AttributeOrigin getOrigin()

Returns the origin of this column content, meta-data that describes where the column comes from. Default value is AttributeOrigin.DATA.

Returns:

the origin of this column content

getId

String getId()

Returns the id of this column. The id is the unique identifier that describes the column data.

Returns:

the id of this column

getDefaultValue

Object getDefaultValue()

Returns the default value for this column. May be null.

The returned Object class type is equal to the class obtained with AttributeType.getType().

Returns:

the default value, or null

getProvider

AttributeValueDelegateProvider getProvider()

Returns the attribute value delegate provider. The Provider is always set if the origin of the current attribute column is AttributeOrigin.DELEGATE.

Returns:

attribute value delegate provider

getTable

AttributeTable getTable()

Returns the table that contains this column

Returns:

Table for the column