org.expasy.mzjava.core.ms.cluster

Class SparseSimilarityGraph.Builder<V>

java.lang.Object

org.expasy.mzjava.core.ms.cluster.SparseSimilarityGraph.Builder<V>

All Implemented Interfaces:

SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Enclosing class:

SparseSimilarityGraph<V>

public static class SparseSimilarityGraph.Builder<V>
extends Object
implements SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Constructor Summary

Constructors

Constructor and Description
SparseSimilarityGraph.Builder(int edgeCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
SparseSimilarityGraph.Builder<V>	add(SimEdge<V> edge) Add the simEdge to the graph.
SparseSimilarityGraph.Builder<V>	add(V vertex) Add the vertex to the graph
SimEdge<V>	add(V vertex1, V vertex2, double score) Create and add an edge from vertex1 to vertex2 with similarity equal to score to the graph.
SparseSimilarityGraph<V>	build()
int	edgeCount() Return the number of edges currently in the graph
boolean	isReusable() Returns true if build can be called more than once, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

SparseSimilarityGraph.Builder

public SparseSimilarityGraph.Builder(int edgeCapacity)

Method Detail

add

public SparseSimilarityGraph.Builder<V> add(V vertex)

Description copied from interface: SimilarityGraphBuilder

Add the vertex to the graph

Specified by:

add in interface SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Parameters:

vertex - the vertex to add

Returns:

this builder

add

public SimEdge<V> add(V vertex1,
             V vertex2,
             double score)

Description copied from interface: SimilarityGraphBuilder

Create and add an edge from vertex1 to vertex2 with similarity equal to score to the graph.

If a vertex is not present in the graph the vertex is added to the graph.

Specified by:

add in interface SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Parameters:

vertex1 - the parent vertex

vertex2 - the child vertex

score - the similarity of the edge

Returns:

the created edge

add

public SparseSimilarityGraph.Builder<V> add(SimEdge<V> edge)

Description copied from interface: SimilarityGraphBuilder

Add the simEdge to the graph.

Specified by:

add in interface SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Parameters:

edge - the edge to add

Returns:

this builder

build

public SparseSimilarityGraph<V> build()

Specified by:

build in interface SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

isReusable

public boolean isReusable()

Description copied from interface: SimilarityGraphBuilder

Returns true if build can be called more than once, false otherwise.

Specified by:

isReusable in interface SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Returns:

true if build can be called more than once, false otherwise

edgeCount

public int edgeCount()

Description copied from interface: SimilarityGraphBuilder

Return the number of edges currently in the graph

Specified by:

edgeCount in interface SimilarityGraphBuilder<V,SparseSimilarityGraph<V>>

Returns:

the number of edges currently in the graph