simudyne.core.graph

Interface LinksApi

All Known Implementing Classes:

Agent, Vertex

public interface LinksApi

Method Summary

Modifier and Type	Method and Description
<L extends Link> L	addLink(long vertexID, java.lang.Class<L> clazz) Vertex.addLink(long, Class, Consumer) without a data injector so no initial function is run for links.
<L extends Link> L	addLink(long vertexID, java.lang.Class<L> clazz, java.util.function.Consumer<L> dataInjector) Create a new link from this vertex to the target vertexID, with the given associated data.
<L extends Link> java.util.List<L>	addLinks(java.util.Collection<java.lang.Long> vertexIDs, java.lang.Class<L> clazz) Vertex.addLinks(Collection, Class) without a data injector so no initial function is run for links.
<L extends Link> java.util.List<L>	addLinks(java.util.Collection<java.lang.Long> vertexIDs, java.lang.Class<L> clazz, java.util.function.Consumer<L> dataInjector) Create a new link from this vertex to a group of target vertexIDs, with the given associated data.
java.util.List<? extends Link>	getLinks() Get all of the vertex's links.
<L extends Link> FilteredLinks<L>	getLinks(java.lang.Class<L> clazz) Get the vertex's links of the given type.
FilteredLinks<? extends Link>	getLinksTo(long targetID) Get the vertex's links to the given target ID.
<L extends Link> FilteredLinks<L>	getLinksTo(long targetID, java.lang.Class<L> clazz) Get the vertex's links of specified class to the given target ID.
boolean	hasLinks(java.lang.Class<? extends Link> clazz)
boolean	hasLinksTo(long targetID)
boolean	hasLinksTo(long targetID, java.lang.Class<? extends Link> clazz)
void	removeLinks() Removes all the vertex's links.
void	removeLinks(java.lang.Class<? extends Link> clazz) Removes all vertex's links of a given type.
void	removeLinksTo(long targetID) Removes the vertex's links to a certain target ID.
void	removeLinksTo(long targetID, java.lang.Class<? extends Link> clazz) Removes the vertex's links to a certain targetID of a given type.

Method Detail

getLinks

<L extends Link> FilteredLinks<L> getLinks(java.lang.Class<L> clazz)

Get the vertex's links of the given type.

Parameters:

clazz - The link data class.

Returns:

List of Links of the given class.

getLinks

java.util.List<? extends Link> getLinks()

Get all of the vertex's links.

Note that without a specific link class, data for the link will not be accessible.

Returns:

A list of vertex ids.

getLinksTo

FilteredLinks<? extends Link> getLinksTo(long targetID)

Get the vertex's links to the given target ID.

Parameters:

targetID - The target vertex ID.

Returns:

List of Links to the given target

getLinksTo

<L extends Link> FilteredLinks<L> getLinksTo(long targetID,
                                             java.lang.Class<L> clazz)

Get the vertex's links of specified class to the given target ID.

Parameters:

targetID - The target vertex ID.

clazz - The link data class

Returns:

List of Links to the given target

removeLinks

void removeLinks()

Removes all the vertex's links.

removeLinks

void removeLinks(java.lang.Class<? extends Link> clazz)

Removes all vertex's links of a given type.

Parameters:

clazz - The link data class.

removeLinksTo

void removeLinksTo(long targetID)

Removes the vertex's links to a certain target ID.

Parameters:

targetID - ID of the vertex you want to remove the link to.

hasLinksTo

boolean hasLinksTo(long targetID)

Parameters:

targetID - The target vertex ID.

Returns:

If the vertex has any Links to vertex with given targetID.

hasLinks

boolean hasLinks(java.lang.Class<? extends Link> clazz)

Parameters:

clazz - The link data class

Returns:

If the vertex has any Links of specified class to other vertices.

hasLinksTo

boolean hasLinksTo(long targetID,
                   java.lang.Class<? extends Link> clazz)

Parameters:

targetID - The target vertex ID.

clazz - The link data class

Returns:

If the vertex has any Links of specified class to vertex with given targetID.

removeLinksTo

void removeLinksTo(long targetID,
                   java.lang.Class<? extends Link> clazz)

Removes the vertex's links to a certain targetID of a given type.

Parameters:

clazz - The link data class.

targetID - ID of the vertex you want to remove the link to.

addLink

<L extends Link> L addLink(long vertexID,
                           java.lang.Class<L> clazz)

Vertex.addLink(long, Class, Consumer) without a data injector so no initial function is run for links.

addLinks

<L extends Link> java.util.List<L> addLinks(java.util.Collection<java.lang.Long> vertexIDs,
                                            java.lang.Class<L> clazz)

Vertex.addLinks(Collection, Class) without a data injector so no initial function is run for links.

addLinks

<L extends Link> java.util.List<L> addLinks(java.util.Collection<java.lang.Long> vertexIDs,
                                            java.lang.Class<L> clazz,
                                            java.util.function.Consumer<L> dataInjector)

Create a new link from this vertex to a group of target vertexIDs, with the given associated data.

Parameters:

vertexIDs - Collection of IDs of the vertex to link to.

dataInjector - Function run when each link is created which can be used to set its values.

Returns:

The created Link.

addLink

<L extends Link> L addLink(long vertexID,
                           java.lang.Class<L> clazz,
                           java.util.function.Consumer<L> dataInjector)

Create a new link from this vertex to the target vertexID, with the given associated data.

Parameters:

vertexID - ID of the vertex to link to.

dataInjector - Function run when each link is created which can be used to set its values.

Returns:

The created Link.