io.improbable.keanu.templating

Class SequenceItem

java.lang.Object

io.improbable.keanu.templating.SequenceItem

All Implemented Interfaces:

VertexDictionary

public class SequenceItem
extends java.lang.Object
implements VertexDictionary

Constructor Summary

Constructors

Constructor and Description
SequenceItem(int index, int uniqueSequenceIdentifier)
SequenceItem(int index, int uniqueSequenceIdentifier, java.lang.String sequenceName)

Method Summary

Modifier and Type	Method and Description
<T extends Vertex<?>> T	add(T v)
<T extends Vertex<?>> T	add(VertexLabel label, T v)
<T extends Vertex<?>> void	addAll(java.util.Collection<T> vertices)
<T extends Vertex<?>> void	addAll(java.util.Map<VertexLabel,T> vertices)
<T extends Vertex<?>> void	addAll(T... vertices)
BooleanProxyVertex	addBooleanProxyFor(VertexLabel label) This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.
BooleanProxyVertex	addBooleanProxyFor(VertexLabel label, long[] shape) This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.
DoubleProxyVertex	addDoubleProxyFor(VertexLabel label) This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.
DoubleProxyVertex	addDoubleProxyFor(VertexLabel label, long[] shape) This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.
IntegerProxyVertex	addIntegerProxyFor(VertexLabel label) This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.
IntegerProxyVertex	addIntegerProxyFor(VertexLabel label, long[] shape) This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.
<V extends Vertex<?>> V	get(VertexLabel label)
java.util.Map<VertexLabel,Vertex<?>>	getContents()
int	getIndex()
java.util.Collection<Vertex<?>>	getProxyVertices()
SequenceItem	withExtraEntries(java.util.Map<VertexLabel,Vertex<?>> extraEntries)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.improbable.keanu.vertices.VertexDictionary

backedBy, of

Constructor Detail

SequenceItem

public SequenceItem(int index,
                    int uniqueSequenceIdentifier)

SequenceItem

public SequenceItem(int index,
                    int uniqueSequenceIdentifier,
                    java.lang.String sequenceName)

Method Detail

addAll

public <T extends Vertex<?>> void addAll(T... vertices)

addAll

public <T extends Vertex<?>> void addAll(java.util.Collection<T> vertices)

addAll

public <T extends Vertex<?>> void addAll(java.util.Map<VertexLabel,T> vertices)

add

public <T extends Vertex<?>> T add(T v)

add

public <T extends Vertex<?>> T add(VertexLabel label,
                                   T v)

getContents

public java.util.Map<VertexLabel,Vertex<?>> getContents()

Returns:

Returns a map of vertex labels to vertices, which covers all of the vertices that have been explicitly added to this sequence item.

getIndex

public int getIndex()

Returns:

the index of the sequence item in the overall Sequence

get

public <V extends Vertex<?>> V get(VertexLabel label)

Specified by:

get in interface VertexDictionary

withExtraEntries

public SequenceItem withExtraEntries(java.util.Map<VertexLabel,Vertex<?>> extraEntries)

Specified by:

withExtraEntries in interface VertexDictionary

getProxyVertices

public java.util.Collection<Vertex<?>> getProxyVertices()

addDoubleProxyFor

public DoubleProxyVertex addDoubleProxyFor(VertexLabel label)

This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.

Parameters:

label - the label of the corresponding vertex from the previous item.

Returns:

a newly created ProxyVertex

addDoubleProxyFor

public DoubleProxyVertex addDoubleProxyFor(VertexLabel label,
                                           long[] shape)

This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.

Parameters:

label - the label of the corresponding vertex from the previous item.

shape - the shape of the corresponding vertex from the previous item.

Returns:

a newly created ProxyVertex

addIntegerProxyFor

public IntegerProxyVertex addIntegerProxyFor(VertexLabel label)

This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.

Parameters:

label - the label of the corresponding vertex from the previous item.

Returns:

a newly created ProxyVertex

addIntegerProxyFor

public IntegerProxyVertex addIntegerProxyFor(VertexLabel label,
                                             long[] shape)

This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.

Parameters:

label - the label of the corresponding vertex from the previous item.

shape - the shape of the corresponding vertex from the previous item.

Returns:

a newly created ProxyVertex

addBooleanProxyFor

public BooleanProxyVertex addBooleanProxyFor(VertexLabel label)

This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.

Parameters:

label - the label of the corresponding vertex from the previous item.

Returns:

a newly created ProxyVertex

addBooleanProxyFor

public BooleanProxyVertex addBooleanProxyFor(VertexLabel label,
                                             long[] shape)

This method creates a ProxyVertex and adds it to the sequence item It also adds this vertex to the sequence item to represent the vertex with this label in the previous sequence item.

Parameters:

label - the label of the corresponding vertex from the previous item.

shape - the shape of the corresponding vertex from the previous item.

Returns:

a newly created ProxyVertex