public interface AttributeColumnsController
This interface defines part of the Data Laboratory API basic actions.
It contains methods for manipulating the attributes and properties of nodes and edges.
Modifier and Type | Method and Description |
---|---|
Column |
addAttributeColumn(Table table,
String title,
Class type)
Adds a new column to the specified table with the given title and type of column.
|
Map<Object,Integer> |
calculateColumnValuesFrequencies(Table table,
Column column)
Calculates the absolute frequency of appearance of each value of the given column and returns a Map containing each different value mapped to its frequency of appearance.
|
boolean |
canChangeColumnData(Column column)
Indicates if the Data Laboratory API behaviour allows to change a value of the given column of a table.
|
boolean |
canClearColumnData(Column column)
Indicates if the Data Laboratory API behaviour allows to set as null a value of the given column of a table.
|
boolean |
canConvertColumnToDynamic(Column column)
Indicates if the Data Laboratory API behaviour allows to convert an existing column into its dynamic equivalent.
|
boolean |
canDeleteColumn(Column column)
Indicates if the Data Laboratory API behaviour allows to delete the given column of a table.
|
void |
clearColumnData(Table table,
Column column)
Clears all rows data for a given column of a table (nodes table or edges table)
|
void |
clearEdgeData(Edge edge,
Column[] columnsToClear)
Clears all edge attributes except computed attributes and id.
|
void |
clearEdgesData(Edge[] edges,
Column[] columnsToClear)
Clears all the edges attributes except computed attributes and id, checking first that the edges are in the graph.
|
void |
clearNodeData(Node node,
Column[] columnsToClear)
Clears all node attributes except computed attributes and id, checking first that the node is in the graph.
|
void |
clearNodesData(Node[] nodes,
Column[] columnsToClear)
Clears all the nodes attributes except computed attributes and id.
|
void |
clearRowData(Element row,
Column[] columnsToClear)
Clears row attributes except computed attributes and id if node/edge row.
|
Column |
convertAttributeColumnToDynamic(Table table,
Column column,
double low,
double high)
Converts and replaces a table column with a dynamic column preserving original column values.
|
Column |
convertAttributeColumnToNewDynamicColumn(Table table,
Column column,
double low,
double high,
String newColumnTitle)
Converts a table column into a new dynamic column preserving original column values.
|
void |
copyColumnDataToOtherColumn(Table table,
Column sourceColumn,
Column targetColumn)
Copies all row values of a column to another column.
|
void |
copyEdgeDataToOtherEdges(Edge edge,
Edge[] otherEdges,
Column[] columnsToCopy)
Copies attributes data of the given edge to the other rows except computed attributes and id.
|
void |
copyNodeDataToOtherNodes(Node node,
Node[] otherNodes,
Column[] columnsToCopy)
Copies attributes data of the given node to the other rows except computed attributes and id.
|
void |
copyRowDataToOtherRows(Element row,
Element[] otherRows,
Column[] columnsToCopy)
Copies attributes data of the given row to the other rows except computed attributes and id if node/edge.
|
Column |
createBooleanMatchesColumn(Table table,
Column column,
String newColumnTitle,
Pattern pattern)
Creates a new
BOOLEAN column from the given column and regular expression
filling it with boolean values that indicate if each of the old column values match the regular expression. |
Column |
createFoundGroupsListColumn(Table table,
Column column,
String newColumnTitle,
Pattern pattern)
Creates a new
LIST_STRING column from the given column and regular expression with values that are
the list of matching groups for the given regular expression for each row. |
void |
deleteAttributeColumn(Table table,
Column column)
Deletes the specified column from a table if the table has the column and data laboratory behaviour allows to delete it (see
canDeleteColumn method). |
List<List<Node>> |
detectNodeDuplicatesByColumn(Column column,
boolean caseSensitive)
Finds and returns nodes duplicates based on the values of a given column of nodes table
|
Column |
duplicateColumn(Table table,
Column column,
String title,
Class type)
Duplicates a given column of a table and copies al row values.
|
void |
fillColumnWithValue(Table table,
Column column,
String value)
Fills the data values of a given column of a table with a value as a String,
parsing it for the
Class of the column. |
void |
fillEdgesColumnWithValue(Edge[] edges,
Column column,
String value)
Fills the data values of a given column of the indicated edges with a value as a String,
parsing it for the
Class of the column. |
void |
fillNodesColumnWithValue(Node[] nodes,
Column column,
String value)
Fills the data values of a given column of the indicated nodes with a value as a String,
parsing it for the
Class of the column. |
Number[] |
getColumnNumbers(Table table,
Column column)
Prepares an array with all not null numbers of all the rows of a given column.
|
BigDecimal[] |
getNumberOrNumberListColumnStatistics(Table table,
Column column)
Calculates all statistics at once from a number/number list column using
MathUtils class. |
Number[] |
getRowNumbers(Element row,
Column[] columns)
Prepares an array with all not null numbers of a row using only the given columns.
|
Number[] |
getRowsColumnNumbers(Element[] rows,
Column column)
Prepares an array only with all not null numbers the indicated rows of a given column.
|
Element[] |
getTableAttributeRows(Table table)
Returns all rows of a given table (node or edges table).
|
int |
getTableRowsCount(Table table)
Counts the number of rows of a table (nodes or edges table) and returns the result.
|
void |
importCSVToEdgesTable(Graph graph,
File file,
Character separator,
Charset charset,
String[] columnNames,
Class[] columnTypes,
boolean createNewNodes)
Method for importing csv data to edges table.
|
void |
importCSVToNodesTable(Graph graph,
File file,
Character separator,
Charset charset,
String[] columnNames,
Class[] columnTypes,
boolean assignNewNodeIds)
Method for importing CSV file data to nodes table.
|
boolean |
isEdgeColumn(Column column) |
boolean |
isEdgeTable(Table table)
Checks if the given table is edges table.
|
boolean |
isNodeColumn(Column column) |
boolean |
isNodeTable(Table table)
Checks if the given table is nodes table.
|
boolean |
isTableColumn(Table table,
Column column) |
void |
mergeRowsValues(Column[] columns,
AttributeRowsMergeStrategy[] mergeStrategies,
Element[] rows,
Element selectedRow,
Element resultRow)
Merges the given rows values to the given result row using one merge strategy for each column of the table.
|
void |
negateBooleanColumn(Table table,
Column column)
Negates not null values of a given
BOOLEAN or LIST_BOOLEAN column. |
boolean |
setAttributeValue(Object value,
Element row,
Column column)
Sets a value to the given row,column pair (cell).
|
boolean setAttributeValue(Object value, Element row, Column column)
Sets a value to the given row,column pair (cell). If the class of the value is not the column type class,
it will try to parse the toString
representation of the value.
Takes care to avoid parsing exceptions of the target column type.
Also, this will not set a null value to a column that can't have null values (see canClearColumnData
method) if the given object is null or the parsing fails.
value
- Value to set, can be nullrow
- Rowcolumn
- ColumnColumn addAttributeColumn(Table table, String title, Class type)
Adds a new column to the specified table with the given title and type of column.
The title for the new column can't be repeated in the table, null or an empty string.
.The id of the column will be set to the same as the title, but if the first TimeInterval column of the table is created it will be given the default dynamic time interval id to be able to use dynamic filters.
The AttributeOrigin
of the column will be set to DATA
.
Default column value will be set to null.
table
- Table to add the columntitle
- Title for the new column, can't be repeated in the table, null or empty stringtype
- Type for the new columnColumn duplicateColumn(Table table, Column column, String title, Class type)
Duplicates a given column of a table and copies al row values.
If the Class
for the new column is different from the old column type, it will try to parse each value. If it is not possible, the value will be set to null.
The title for the new column can't be repeated in the table, null or an empty string.
.The id of the column will be set to the title.
The AttributeOrigin
of the column will be set to DATA
.
Default column value will be set to null.
table
- Table of the column to duplicatecolumn
- Column to duplicatetitle
- Title for the new columntype
- Class for the new columnvoid copyColumnDataToOtherColumn(Table table, Column sourceColumn, Column targetColumn)
Copies all row values of a column to another column.
If the Class
for the target is different from the source column type, it will try to parse each value. If it is not possible, the value will be set to null.
Source and target columns must be different.
table
- Table of the columnssourceColumn
- Source columntargetColumn
- Target columnvoid deleteAttributeColumn(Table table, Column column)
Deletes the specified column from a table if the table has the column and data laboratory behaviour allows to delete it (see canDeleteColumn
method).
table
- Table to delete the columncolumn
- Column to deleteColumn convertAttributeColumnToDynamic(Table table, Column column, double low, double high)
Converts and replaces a table column with a dynamic column preserving original column values.
This should be used only in columns where the canConvertColumnToDynamic
returns true
The new values have a default interval that uses the low, high, lopen and ropen parameters.
table
- Table of the columncolumn
- Column to convert and replacelow
- Low bound for default intervalhigh
- High bound for default intervalColumn convertAttributeColumnToNewDynamicColumn(Table table, Column column, double low, double high, String newColumnTitle)
Converts a table column into a new dynamic column preserving original column values. The original column is kept intact
The new values have a default interval that uses the low, high, lopen and ropen parameters.
table
- Table of the columncolumn
- Column to convert to dynamiclow
- Low bound for default intervalhigh
- High bound for default intervalnewColumnTitle
- Title for the new dynamic columnvoid fillColumnWithValue(Table table, Column column, String value)
Fills the data values of a given column of a table with a value as a String,
parsing it for the Class
of the column. If it is not possible to parse,
the value will be set to null.
table
- Table of the columncolumn
- Column to fillvalue
- String representation of the value for each row of the columnvoid fillNodesColumnWithValue(Node[] nodes, Column column, String value)
Fills the data values of a given column of the indicated nodes with a value as a String,
parsing it for the Class
of the column. If it is not possible to parse,
the value will be set to null.
nodes
- Nodes to fillcolumn
- Column to fillvalue
- String representation of the value for the column for each nodevoid fillEdgesColumnWithValue(Edge[] edges, Column column, String value)
Fills the data values of a given column of the indicated edges with a value as a String,
parsing it for the Class
of the column. If it is not possible to parse,
the value will be set to null.
edges
- Edges to fillcolumn
- Column to fillvalue
- String representation of the value for the column for each edgevoid clearColumnData(Table table, Column column)
Clears all rows data for a given column of a table (nodes table or edges table)
table
- Table to clear column datacolumn
- Column to clear dataMap<Object,Integer> calculateColumnValuesFrequencies(Table table, Column column)
Calculates the absolute frequency of appearance of each value of the given column and returns a Map containing each different value mapped to its frequency of appearance.
table
- Table of the columncolumn
- Column to calculate values frequenciesColumn createBooleanMatchesColumn(Table table, Column column, String newColumnTitle, Pattern pattern)
Creates a new BOOLEAN
column from the given column and regular expression
filling it with boolean values that indicate if each of the old column values match the regular expression.
Title for the new column can't be repeated in the table, null or empty.
table
- Table of the column to matchcolumn
- Column to matchnewColumnTitle
- Title for the new boolean columnpattern
- Regular expression to matchvoid negateBooleanColumn(Table table, Column column)
Negates not null values of a given BOOLEAN
or LIST_BOOLEAN
column.
Throws IllegalArgumentException if the column does not have BOOLEAN
or LIST_BOOLEAN
Class
.
table
- Table of the column to negatecolumn
- Boolean column to negateColumn createFoundGroupsListColumn(Table table, Column column, String newColumnTitle, Pattern pattern)
Creates a new LIST_STRING
column from the given column and regular expression with values that are
the list of matching groups for the given regular expression for each row.
The title for the new column can't be repeated in the table, null or an empty string.
.table
- Table of the column to matchcolumn
- Column to matchnewColumnTitle
- Title for the new boolean columnpattern
- Regular expression to matchvoid clearNodeData(Node node, Column[] columnsToClear)
Clears all node attributes except computed attributes and id, checking first that the node is in the graph.
Columns to clear can be specified, but id and computed columns will not be cleared.
node
- Node to clear datacolumnsToClear
- Columns of the node to clear. All columns will be cleared if it is nullvoid clearNodesData(Node[] nodes, Column[] columnsToClear)
Clears all the nodes attributes except computed attributes and id.
Columns to clear can be specified, but id and computed columns will not be cleared.
nodes
- Array of nodes to clear datacolumnsToClear
- Columns of the nodes to clear. All columns will be cleared if it is nullvoid clearEdgeData(Edge edge, Column[] columnsToClear)
Clears all edge attributes except computed attributes and id.
Columns to clear can be specified, but id and computed columns will not be cleared.
edge
- Edge to clear datacolumnsToClear
- Columns of the edge to clear. All columns will be cleared if it is nullvoid clearEdgesData(Edge[] edges, Column[] columnsToClear)
Clears all the edges attributes except computed attributes and id, checking first that the edges are in the graph.
Columns to clear can be specified, but id and computed columns will not be cleared.
edges
- Array of edges to clear datacolumnsToClear
- Columns of the edges to clear. All columns will be cleared if it is nullvoid clearRowData(Element row, Column[] columnsToClear)
Clears row attributes except computed attributes and id if node/edge row.
Columns to clear can be specified, but id of node/edge and computed columns will not be cleared.
row
- Array of rows to clear datacolumnsToClear
- Columns of the row to clear. All columns will be cleared if it is nullvoid copyNodeDataToOtherNodes(Node node, Node[] otherNodes, Column[] columnsToCopy)
Copies attributes data of the given node to the other rows except computed attributes and id.
Columns to copy can be specified, but id node and computed columns will not be copied.
node
- Node to copy data fromotherNodes
- Nodes to copy data tocolumnsToCopy
- Columns of the node to copy. All columns will be copied if it is nullvoid copyEdgeDataToOtherEdges(Edge edge, Edge[] otherEdges, Column[] columnsToCopy)
Copies attributes data of the given edge to the other rows except computed attributes and id.
Columns to copy can be specified, but id edge and computed columns will not be copied.
edge
- Edge to copy data fromotherEdges
- Edges to copy data tocolumnsToCopy
- Columns of the edge to copy. All columns will be copied if it is nullvoid copyRowDataToOtherRows(Element row, Element[] otherRows, Column[] columnsToCopy)
Copies attributes data of the given row to the other rows except computed attributes and id if node/edge.
Columns to copy can be specified, but id of node/edge and computed columns will not be copied.
row
- Row to copy data fromotherRows
- Rows to copy data tocolumnsToCopy
- Columns of the row to copy. All columns will be copied if it is nullElement[] getTableAttributeRows(Table table)
Returns all rows of a given table (node or edges table).
Used for iterating through all attribute rows of a table
table
- Table to get attribute rowsint getTableRowsCount(Table table)
Counts the number of rows of a table (nodes or edges table) and returns the result.
Uses GraphElementsController
getNodesCount
and getEdgesCount
to calculate the result.
table
- table
boolean isNodeTable(Table table)
Checks if the given table is nodes table.
table
- Table to checkboolean isEdgeTable(Table table)
Checks if the given table is edges table.
table
- Table to checkboolean isNodeColumn(Column column)
boolean isEdgeColumn(Column column)
boolean canDeleteColumn(Column column)
Indicates if the Data Laboratory API behaviour allows to delete the given column of a table.
The behaviour is: Any column that does not have a AttributeOrigin
of type PROPERTY
can be deleted.
column
- Column to check if it can be deletedboolean canChangeColumnData(Column column)
Indicates if the Data Laboratory API behaviour allows to change a value of the given column of a table.
The behaviour is: Only values of columns with AttributeOrigin
of type DATA
or a node/edge label and weight column can be changed. (but weight can't be null. see canClearColumnData
method).
column
- Column to check if values can be changedboolean canClearColumnData(Column column)
Indicates if the Data Laboratory API behaviour allows to set as null a value of the given column of a table.
The behaviour is: Only values of columns with AttributeOrigin
of type DATA
or a node/edge label column can be set to null. Edge weight can't be null
column
- Column to check if values can be changedboolean canConvertColumnToDynamic(Column column)
Indicates if the Data Laboratory API behaviour allows to convert an existing column into its dynamic equivalent.
The behaviour is: Only values of columns with AttributeOrigin
of type DATA
and edge weight can be converted.
column
- Column to check if can be convertedBigDecimal[] getNumberOrNumberListColumnStatistics(Table table, Column column)
Calculates all statistics at once from a number/number list column using MathUtils
class.
Returns an array of length=8 of BigDecimal
numbers with the results in the following order:
The column can only be a number/number list column.
Otherwise, a IllegalArgumentException will be thrown.
table
- Table of the columncolumn
- Column to get statisticsNumber[] getColumnNumbers(Table table, Column column)
Prepares an array with all not null numbers of all the rows of a given column.
The column can only be a number/number list column.
Otherwise, a IllegalArgumentException will be thrown.
table
- Table of the column to get numberscolumn
- Column to get numbersNumber[] getRowsColumnNumbers(Element[] rows, Column column)
Prepares an array only with all not null numbers the indicated rows of a given column.
The column can only be a number/number list column.
Otherwise, a IllegalArgumentException will be thrown.
rows
- Rows to get numberscolumn
- Column to get numbersNumber[] getRowNumbers(Element row, Column[] columns)
Prepares an array with all not null numbers of a row using only the given columns.
The columns can only be number/dynamic number/number list columns (in any combination).
All numbers intervals of a dynamic number column will be used.
Otherwise, a IllegalArgumentException will be thrown.
row
- Row to get numberscolumns
- Columns of the row to usevoid importCSVToNodesTable(Graph graph, File file, Character separator, Charset charset, String[] columnNames, Class[] columnTypes, boolean assignNewNodeIds)
Method for importing CSV file data to nodes table.
Only special case is treating columns is id columns: first column found named 'id' (case insensitive) will be used as node id, others will be ignored.
No special column must be provided.
If a column name is not already in nodes table, it will be created with the corresponding columnType index.
If a node id already exists, depending on assignNewNodeIds, a new id will be assigned to it or instead, the already existing node attributes will be updated with the CSV data
graph
- Graph to import nodesfile
- CSV fileseparator
- Separator of values of the CSV filecharset
- Charset of the CSV filecolumnNames
- Names of the columns in the CSV file to usecolumnTypes
- Types of the columns in the CSV file to use when creating columnsassignNewNodeIds
- Indicates if nodes should be assigned new ids when the ids are already in nodes table or not provided.void importCSVToEdgesTable(Graph graph, File file, Character separator, Charset charset, String[] columnNames, Class[] columnTypes, boolean createNewNodes)
Method for importing csv data to edges table.
Column named 'Source' and 'Target' (case insensitive) should be provided. Any row that does not provide a source and target nodes ids will be ignored.
If no 'Type' (case insensitive) column is provided, all edges will be directed.
If an edge already exists and cannot be created, it will be ignored but the weight of the existing edge will be increased with each repetition.
Special cases are id, source, target and type columns:
graph
- Graph to import edgesfile
- CSV fileseparator
- Separator of values of the CSV filecharset
- Charset of the CSV filecolumnNames
- Names of the columns in the CSV file to usecolumnTypes
- Types of the columns in the CSV file to use when creating columnscreateNewNodes
- Indicates if missing nodes should be created when an edge declares a source or target id not already existingvoid mergeRowsValues(Column[] columns, AttributeRowsMergeStrategy[] mergeStrategies, Element[] rows, Element selectedRow, Element resultRow)
Merges the given rows values to the given result row using one merge strategy for each column of the table.
The number of columns must be equal to the number of merge strategies provided
No parameters can be null except selectedRow (first row will be used in case selectedRow is null)
If any strategy is null, the value of the selectedRow will be used
columns
- Columns to apply a merge strategy in each rowmergeStrategies
- Strategies for each column in columns
rows
- Rows to merge (at least 1)selectedRow
- Main selected row or null (first row will be used in case selectedRow is null)resultRow
- Already existing row to put the values onList<List<Node>> detectNodeDuplicatesByColumn(Column column, boolean caseSensitive)
Finds and returns nodes duplicates based on the values of a given column of nodes table
A node is a duplicate of other if they have the same value (String representation of the values is used) in the given column.
This is useful to be used to automatically merge duplicated nodes
column
- Column to use values to detect duplicatescaseSensitive
- Case insensitivity when comparing the column valuesCopyright © 2007–2015 Gephi Consortium. All rights reserved.