Gephi Toolkit Javadoc

org.gephi.data.properties
Enum PropertiesColumn

java.lang.Object
  extended by java.lang.Enum<PropertiesColumn>
      extended by org.gephi.data.properties.PropertiesColumn
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PropertiesColumn>

public enum PropertiesColumn
extends java.lang.Enum<PropertiesColumn>

Enum that define static AttributeColumn indexes, like ID or LABEL. Use these enum to find the index of these columns in node and edge table.

Get nodes ID column
 AttributeColumn col = nodeTable.getColumn(PropertiesColumn.NODE_ID.getIndex());
 

Author:
Mathieu Bastian, Martin Ć kurla

Enum Constant Summary
EDGE_ID
           
EDGE_LABEL
           
EDGE_WEIGHT
           
GRAPH_DESCRIPTION
           
GRAPH_NAME
           
NEO4J_RELATIONSHIP_TYPE
           
NODE_ID
           
NODE_LABEL
           
 
Method Summary
 java.lang.Object getDefaultValue()
           
 java.lang.String getId()
           
 int getIndex()
           
 AttributeOrigin getOrigin()
           
 java.lang.String getTitle()
          Returns column title which will be showed to user in AttributeTables.
 AttributeType getType()
           
static PropertiesColumn valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PropertiesColumn[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NODE_ID

public static final PropertiesColumn NODE_ID

NODE_LABEL

public static final PropertiesColumn NODE_LABEL

EDGE_ID

public static final PropertiesColumn EDGE_ID

EDGE_LABEL

public static final PropertiesColumn EDGE_LABEL

EDGE_WEIGHT

public static final PropertiesColumn EDGE_WEIGHT

GRAPH_NAME

public static final PropertiesColumn GRAPH_NAME

GRAPH_DESCRIPTION

public static final PropertiesColumn GRAPH_DESCRIPTION

NEO4J_RELATIONSHIP_TYPE

public static final PropertiesColumn NEO4J_RELATIONSHIP_TYPE
Method Detail

values

public static PropertiesColumn[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (PropertiesColumn c : PropertiesColumn.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertiesColumn valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getIndex

public int getIndex()

getId

public java.lang.String getId()

getTitle

public java.lang.String getTitle()
Returns column title which will be showed to user in AttributeTables. Default title is derived from id uppercasing first character. For multiword titles, getTitle() method in appropriate enum constant object should be overridden.

Returns:
title

getDefaultValue

public java.lang.Object getDefaultValue()

getType

public AttributeType getType()

getOrigin

public AttributeOrigin getOrigin()

Gephi Toolkit Javadoc