org.gephi.io.importer.impl

Class ImportContainerImpl

java.lang.Object

org.gephi.io.importer.impl.ImportContainerImpl

All Implemented Interfaces:

Container, ContainerLoader, ContainerUnloader

public class ImportContainerImpl
extends Object
implements Container, ContainerLoader, ContainerUnloader

Author:

Mathieu Bastian

Nested Class Summary

Nested classes/interfaces inherited from interface org.gephi.io.importer.api.Container

Container.Factory

Constructor Summary

Constructors

Constructor and Description
ImportContainerImpl()

Method Summary

Modifier and Type	Method and Description
void	addEdge(EdgeDraft edgeDraft) Adds an edge to this container.
ColumnDraft	addEdgeColumn(String key, Class typeClass) Adds a new edge column to this container.
ColumnDraft	addEdgeColumn(String key, Class typeClass, boolean dynamic) Adds a new dynamic edge column to this container.
void	addNode(NodeDraft nodeDraft) Adds a node to this container.
ColumnDraft	addNodeColumn(String key, Class typeClass) Adds a new node column to this container.
ColumnDraft	addNodeColumn(String key, Class typeClass, boolean dynamic) Adds a new dynamic node column to this container.
boolean	allowAutoNode()
boolean	allowParallelEdges()
boolean	allowSelfLoop()
void	closeLoader() Close the current loading and clean content before unloading.
boolean	edgeExists(String id) Returns true if an edge exists with the given id.
boolean	edgeExists(String source, String target) Returns true if an edge exists from source to target.
ElementFactoryImpl	factory() Returns the factory for building nodes and edges instances.
EdgeDraft	getEdge(String id) Returns the edge with the given id, or null if not found.
ColumnDraft	getEdgeColumn(String key) Returns the edge column draft with key as identifier.
Iterable<ColumnDraft>	getEdgeColumns()
int	getEdgeCount()
EdgeDirectionDefault	getEdgeDefault()
Iterable<EdgeDraft>	getEdges()
EdgeMergeStrategy	getEdgesMergeStrategy()
Class	getEdgeTypeLabelClass()
ElementIdType	getElementIdType()
org.gephi.graph.api.Interval	getInterval()
ContainerLoader	getLoader() Gets the container loading interface.
NodeDraftImpl	getNode(String id) Returns the node with the given id, or create a new node with this id if not found.
ColumnDraft	getNodeColumn(String key) Returns the node column draft with key as identifier.
Iterable<ColumnDraft>	getNodeColumns()
int	getNodeCount()
Iterable<NodeDraft>	getNodes()
Report	getReport() Returns the report associated to this container, if it exists.
String	getSource() If exists, returns the source of the data.
org.gephi.graph.api.TimeFormat	getTimeFormat()
org.gephi.graph.api.TimeRepresentation	getTimeRepresentation() Gets the current time representation, either TIMESTAMP or INTERVAL.
Double	getTimestamp()
org.joda.time.DateTimeZone	getTimeZone()
ContainerUnloader	getUnloader() Get the container unloading interface.
boolean	hasDynamicAttributes() Returns true if this container contains elements that have dynamic attributes.
boolean	hasEdgeColumn(String key)
boolean	hasNodeColumn(String key)
boolean	hasSelfLoops() Returns true if edges in this container are self-loops.
boolean	isAutoScale()
boolean	isDynamicGraph() Returns true if this container contains a dynamic graph.
boolean	isFillLabelWithId()
boolean	isMultiGraph() Returns true if this container contains a multigraph.
boolean	nodeExists(String id) Returns true if a node exists with the given id.
void	removeEdge(EdgeDraft edgeDraft) Removes an edge from this container.
void	setAllowAutoNode(boolean value)
void	setAllowParallelEdge(boolean value)
void	setAllowSelfLoop(boolean value)
void	setAutoScale(boolean autoscale)
void	setEdgeDefault(EdgeDirectionDefault edgeDefault) Set edge default type: DIRECTED, UNDIRECTED or MIXED.
void	setEdgesMergeStrategy(EdgeMergeStrategy edgesMergeStrategy)
void	setElementIdType(ElementIdType type) Sets the type of the id for elements.
void	setFillLabelWithId(boolean value)
void	setInterval(String startDateTime, String endDateTime) Sets the interval for the entire graph.
void	setReport(Report report) Sets a report this container can use to report issues detected when loading the container.
void	setSource(String source) Sets the source of the data put in the container.
void	setTimeFormat(org.gephi.graph.api.TimeFormat timeFormat) Sets the current Time Format for dynamic data, either DATE, DATETIME or DOUBLE.
void	setTimeRepresentation(org.gephi.graph.api.TimeRepresentation timeRepresentation) Sets the current time representation, either TIMESTAMP or INTERVAL.
void	setTimestamp(String timestamp) Sets the timestamp for the entire graph.
void	setTimeZone(org.joda.time.DateTimeZone timeZone) Sets the time zone that is used to parse date and time.
boolean	verify() This method must be called after the loading is complete and before unloading.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImportContainerImpl

public ImportContainerImpl()

Method Detail

getLoader

public ContainerLoader getLoader()

Description copied from interface: Container

Gets the container loading interface.

The loader is used by modules which put data in the container, whereas the unloader interface is used by modules which read containers content.

Specified by:

getLoader in interface Container

Returns:

containers loading interface

getUnloader

public ContainerUnloader getUnloader()

Description copied from interface: Container

Get the container unloading interface.

The unloader interface is used by modules which read containers content, whereas the loader is used for pushing data in the container.

Specified by:

getUnloader in interface Container

Returns:

container unloading interface

factory

public ElementFactoryImpl factory()

Description copied from interface: ContainerLoader

Returns the factory for building nodes and edges instances.

Specified by:

factory in interface ContainerLoader

Returns:

the draft factory

setSource

public void setSource(String source)

Description copied from interface: Container

Sets the source of the data put in the container. Could be a file name.

Specified by:

setSource in interface Container

Parameters:

source - original source of data.

getSource

public String getSource()

Description copied from interface: Container

If exists, returns the source of the data.

Specified by:

getSource in interface Container

Specified by:

getSource in interface ContainerUnloader

Returns:

source of the data, or null if source is not defined.

addNode

public void addNode(NodeDraft nodeDraft)

Description copied from interface: ContainerLoader

Adds a node to this container. Identified by its id. If no id is present, a unique identifier is generated.

Specified by:

addNode in interface ContainerLoader

Parameters:

nodeDraft - node that is to be pushed to this container

getNode

public NodeDraftImpl getNode(String id)

Description copied from interface: ContainerLoader

Returns the node with the given id, or create a new node with this id if not found.

Specified by:

getNode in interface ContainerLoader

Parameters:

id - node identifier

Returns:

found node, or a new default node

nodeExists

public boolean nodeExists(String id)

Description copied from interface: ContainerLoader

Returns true if a node exists with the given id.

Specified by:

nodeExists in interface ContainerLoader

Parameters:

id - node identifier

Returns:

true if node exists, false otherwise

edgeExists

public boolean edgeExists(String source,
                          String target)

Description copied from interface: ContainerLoader

Returns true if an edge exists from source to target.

Specified by:

edgeExists in interface ContainerLoader

Parameters:

source - edge source node

target - edge target node

Returns:

true if edges exists, false otherwise

addEdge

public void addEdge(EdgeDraft edgeDraft)

Description copied from interface: ContainerLoader

Adds an edge to this container. The edge must have source and target defined. If the edge already exist, it is ignored. Source and target nodes must be added to the container before pushing edgeDraft.

Specified by:

addEdge in interface ContainerLoader

Parameters:

edgeDraft - edge that is to be pushed to this container

removeEdge

public void removeEdge(EdgeDraft edgeDraft)

Description copied from interface: ContainerLoader

Removes an edge from this container. Do nothing if the edge is not in the container.

Specified by:

removeEdge in interface ContainerLoader

Parameters:

edgeDraft - edge that is to be removed from this container

edgeExists

public boolean edgeExists(String id)

Description copied from interface: ContainerLoader

Returns true if an edge exists with the given id.

Specified by:

edgeExists in interface ContainerLoader

Parameters:

id - an edge identifier

Returns:

true if edge exists, false otherwise

getEdge

public EdgeDraft getEdge(String id)

Description copied from interface: ContainerLoader

Returns the edge with the given id, or null if not found.

Specified by:

getEdge in interface ContainerLoader

Parameters:

id - edge identifier

Returns:

edge with id as an identifier, or null if not found

getNodes

public Iterable<NodeDraft> getNodes()

Specified by:

getNodes in interface ContainerUnloader

getNodeCount

public int getNodeCount()

Specified by:

getNodeCount in interface ContainerUnloader

getEdges

public Iterable<EdgeDraft> getEdges()

Specified by:

getEdges in interface ContainerUnloader

getEdgeCount

public int getEdgeCount()

Specified by:

getEdgeCount in interface ContainerUnloader

getTimeFormat

public org.gephi.graph.api.TimeFormat getTimeFormat()

Specified by:

getTimeFormat in interface ContainerUnloader

setTimeFormat

public void setTimeFormat(org.gephi.graph.api.TimeFormat timeFormat)

Description copied from interface: ContainerLoader

Sets the current Time Format for dynamic data, either DATE, DATETIME or DOUBLE. It configures how the dates are formatted.

The default value is DOUBLE.

Specified by:

setTimeFormat in interface ContainerLoader

Parameters:

timeFormat - time format

getTimeRepresentation

public org.gephi.graph.api.TimeRepresentation getTimeRepresentation()

Description copied from interface: ContainerLoader

Gets the current time representation, either TIMESTAMP or INTERVAL.

Specified by:

getTimeRepresentation in interface ContainerLoader

Specified by:

getTimeRepresentation in interface ContainerUnloader

Returns:

time representation

setTimeRepresentation

public void setTimeRepresentation(org.gephi.graph.api.TimeRepresentation timeRepresentation)

Description copied from interface: ContainerLoader

Sets the current time representation, either TIMESTAMP or INTERVAL.

The default value is INTERVAL.

Specified by:

setTimeRepresentation in interface ContainerLoader

Parameters:

timeRepresentation - time representation

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

Specified by:

getTimeZone in interface ContainerUnloader

setTimeZone

public void setTimeZone(org.joda.time.DateTimeZone timeZone)

Description copied from interface: ContainerLoader

Sets the time zone that is used to parse date and time.

If not set, the local time zone is used.

Specified by:

setTimeZone in interface ContainerLoader

Parameters:

timeZone - time zone

addNodeColumn

public ColumnDraft addNodeColumn(String key,
                                 Class typeClass)

Description copied from interface: ContainerLoader

Adds a new node column to this container.

If a column with this key already exists, it is ignored and return the existing column.

Specified by:

addNodeColumn in interface ContainerLoader

Parameters:

key - node column identifier

typeClass - node column type

Returns:

column draft

addNodeColumn

public ColumnDraft addNodeColumn(String key,
                                 Class typeClass,
                                 boolean dynamic)

Description copied from interface: ContainerLoader

Adds a new dynamic node column to this container.

Dynamic attributes have values over time.

If a column with this key already exists, it is ignored and return the existing column.

Specified by:

addNodeColumn in interface ContainerLoader

Parameters:

key - node column identifier

typeClass - node column type

dynamic - true if the column needs to be dynamic, false otherwise

Returns:

column draft

addEdgeColumn

public ColumnDraft addEdgeColumn(String key,
                                 Class typeClass)

Description copied from interface: ContainerLoader

Adds a new edge column to this container.

If a column with this key already exists, it is ignored and return the existing column.

Specified by:

addEdgeColumn in interface ContainerLoader

Parameters:

key - edge column identifier

typeClass - edge column type

Returns:

column draft

addEdgeColumn

public ColumnDraft addEdgeColumn(String key,
                                 Class typeClass,
                                 boolean dynamic)

Description copied from interface: ContainerLoader

Adds a new dynamic edge column to this container.

Dynamic attributes have values over time.

If a column with this key already exists, it is ignored and return the existing column.

Specified by:

addEdgeColumn in interface ContainerLoader

Parameters:

key - edge column identifier

typeClass - edge column type

dynamic - true if the column needs to be dynamic, false otherwise

Returns:

column draft

getNodeColumn

public ColumnDraft getNodeColumn(String key)

Description copied from interface: ContainerLoader

Returns the node column draft with key as identifier.

Specified by:

getNodeColumn in interface ContainerLoader

Specified by:

getNodeColumn in interface ContainerUnloader

Parameters:

key - node column key

Returns:

column draft or null if not found

hasNodeColumn

public boolean hasNodeColumn(String key)

Specified by:

hasNodeColumn in interface ContainerUnloader

getEdgeColumn

public ColumnDraft getEdgeColumn(String key)

Description copied from interface: ContainerLoader

Returns the edge column draft with key as identifier.

Specified by:

getEdgeColumn in interface ContainerLoader

Specified by:

getEdgeColumn in interface ContainerUnloader

Parameters:

key - edge column key

Returns:

column draft or null if not found

hasEdgeColumn

public boolean hasEdgeColumn(String key)

Specified by:

hasEdgeColumn in interface ContainerUnloader

getNodeColumns

public Iterable<ColumnDraft> getNodeColumns()

Specified by:

getNodeColumns in interface ContainerUnloader

getEdgeColumns

public Iterable<ColumnDraft> getEdgeColumns()

Specified by:

getEdgeColumns in interface ContainerUnloader

setTimestamp

public void setTimestamp(String timestamp)

Description copied from interface: ContainerLoader

Sets the timestamp for the entire graph. All elements and all dynamic columns will automatically receive this timestamp when the graph is processed.

Specified by:

setTimestamp in interface ContainerLoader

Parameters:

timestamp - timestamp

setInterval

public void setInterval(String startDateTime,
                        String endDateTime)

Description copied from interface: ContainerLoader

Sets the interval for the entire graph. All elements and all dynamic columns will automatically receive this interval when the graph is processed.

Specified by:

setInterval in interface ContainerLoader

Parameters:

startDateTime - interval start

endDateTime - interval end

getInterval

public org.gephi.graph.api.Interval getInterval()

Specified by:

getInterval in interface ContainerUnloader

getTimestamp

public Double getTimestamp()

Specified by:

getTimestamp in interface ContainerUnloader

setElementIdType

public void setElementIdType(ElementIdType type)

Description copied from interface: ContainerLoader

Sets the type of the id for elements.

Specified by:

setElementIdType in interface ContainerLoader

Parameters:

type - id type

getElementIdType

public ElementIdType getElementIdType()

Specified by:

getElementIdType in interface ContainerUnloader

verify

public boolean verify()

Description copied from interface: Container

This method must be called after the loading is complete and before unloading.

It aims to verify data consistency as a whole.

Specified by:

verify in interface Container

Returns:

true if container data is consistent, false otherwise

closeLoader

public void closeLoader()

Description copied from interface: Container

Close the current loading and clean content before unloading.

Specified by:

closeLoader in interface Container

isDynamicGraph

public boolean isDynamicGraph()

Description copied from interface: Container

Returns true if this container contains a dynamic graph.

A dynamic graph has elements that appear or disappear over time.

Specified by:

isDynamicGraph in interface Container

Returns:

true if dynamic, false otherwise

hasDynamicAttributes

public boolean hasDynamicAttributes()

Description copied from interface: Container

Returns true if this container contains elements that have dynamic attributes.

Dynamic attributes are attributes with different values over time.

Specified by:

hasDynamicAttributes in interface Container

Returns:

true if dynamic attributes, false otherwise

getReport

public Report getReport()

Description copied from interface: Container

Returns the report associated to this container, if it exists.

Specified by:

getReport in interface Container

Returns:

report set for this container or null if no report is defined

setReport

public void setReport(Report report)

Description copied from interface: Container

Sets a report this container can use to report issues detected when loading the container.

Report are used to log info and issues during import process. Only one report can be associated to a container.

Specified by:

setReport in interface Container

Parameters:

report - set report as the default report for this container

allowAutoNode

public boolean allowAutoNode()

Specified by:

allowAutoNode in interface ContainerUnloader

allowParallelEdges

public boolean allowParallelEdges()

Specified by:

allowParallelEdges in interface ContainerUnloader

allowSelfLoop

public boolean allowSelfLoop()

Specified by:

allowSelfLoop in interface ContainerUnloader

isFillLabelWithId

public boolean isFillLabelWithId()

Specified by:

isFillLabelWithId in interface ContainerUnloader

getEdgesMergeStrategy

public EdgeMergeStrategy getEdgesMergeStrategy()

Specified by:

getEdgesMergeStrategy in interface ContainerUnloader

getEdgeDefault

public EdgeDirectionDefault getEdgeDefault()

Specified by:

getEdgeDefault in interface ContainerUnloader

isMultiGraph

public boolean isMultiGraph()

Description copied from interface: Container

Returns true if this container contains a multigraph.

A multi-graph is a graph that has several types of edges (i.e. edges with different labels).

Specified by:

isMultiGraph in interface Container

Returns:

true if multigraph, false otherwise

hasSelfLoops

public boolean hasSelfLoops()

Description copied from interface: Container

Returns true if edges in this container are self-loops.

Specified by:

hasSelfLoops in interface Container

Returns:

true if presence of self-loops, false otherwise

setAllowAutoNode

public void setAllowAutoNode(boolean value)

Specified by:

setAllowAutoNode in interface ContainerLoader

setAllowParallelEdge

public void setAllowParallelEdge(boolean value)

Specified by:

setAllowParallelEdge in interface ContainerLoader

setAllowSelfLoop

public void setAllowSelfLoop(boolean value)

Specified by:

setAllowSelfLoop in interface ContainerLoader

setFillLabelWithId

public void setFillLabelWithId(boolean value)

Specified by:

setFillLabelWithId in interface ContainerLoader

setEdgeDefault

public void setEdgeDefault(EdgeDirectionDefault edgeDefault)

Description copied from interface: ContainerLoader

Set edge default type: DIRECTED, UNDIRECTED or MIXED. Default value is directed.

Specified by:

setEdgeDefault in interface ContainerLoader

Parameters:

edgeDefault - edge default type value

isAutoScale

public boolean isAutoScale()

Specified by:

isAutoScale in interface ContainerUnloader

setAutoScale

public void setAutoScale(boolean autoscale)

Specified by:

setAutoScale in interface ContainerLoader

setEdgesMergeStrategy

public void setEdgesMergeStrategy(EdgeMergeStrategy edgesMergeStrategy)

Specified by:

setEdgesMergeStrategy in interface ContainerLoader

getEdgeTypeLabelClass

public Class getEdgeTypeLabelClass()

Specified by:

getEdgeTypeLabelClass in interface ContainerUnloader