ome.services.graphs

Class GraphState

java.lang.Object

ome.services.graphs.GraphState

All Implemented Interfaces:

GraphStep.Callback

Deprecated.

will be removed in OMERO 5.2, so use the new graphs implementation

@Deprecated
public class GraphState
extends Object
implements GraphStep.Callback

Tree-structure containing all scheduled actions which closely resembles the tree structure of the GraphSpec itself. All ids of the intended actions will be collected in a preliminary phase. This is necessary since intermediate actions may disconnect the graph, causing later actions to fail if they were solely based on the id of the root element. The GraphState instance can only be initialized with a graph of initialized s. To handle SOFT requirements, each new attempt to process either a node or a leaf in the subgraph is surrounded by a savepoint. Ids added during a savepoint (or a sub-savepoint) are only valid until release is called, at which time they are merged into the final view.

Since:

Beta4.2.3

Author:

Josh Moore, josh at glencoesoftware.com

Constructor Summary

Constructors

Constructor and Description
GraphState(EventContext ec, GraphStepFactory factory, ome.util.SqlAction sql, org.hibernate.Session session, GraphSpec spec) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	add() Deprecated.
void	addGraphIds(GraphStep step) Deprecated. Add the actually processed ids to the current savepoint.
int	collapse(boolean keep) Deprecated.
Iterable<Map.Entry<String,Set<Long>>>	entrySet() Deprecated.
String	execute(int j) Deprecated.
Class<ome.model.IObject>	getClass(String key) Deprecated.
GraphOpts	getOpts() Deprecated.
Set<Long>	getProcessedIds(String table) Deprecated. Get the set of ids which were actually processed.
GraphStep	getStep(int i) Deprecated.
int	getTotalFoundCount() Deprecated. Return the total number of ids loaded into this instance.
int	getTotalProcessedCount() Deprecated. Return the total number of ids which were processed.
String	perform(int j, boolean validate) Deprecated.
void	release(String savepoint, int count) Deprecated.
void	rollback(String savepoint, int count) Deprecated.
void	savepoint(String savepoint) Deprecated.
int	size() Deprecated.
String	toString() Deprecated.
String	validate(int j) Deprecated.
int	validation() Deprecated. Prepares the next phase (validate(int)) by returning how many validation steps should be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphState

public GraphState(EventContext ec,
          GraphStepFactory factory,
          ome.util.SqlAction sql,
          org.hibernate.Session session,
          GraphSpec spec)
           throws GraphException

Deprecated.

Parameters:

Base - EventContext instance which will be used to create a special EventContext based on the current graph. This second instance will be passed to each created step via GraphSpec#setEventContext(EventContext).

ctx - Stored the OmeroContext instance for raising event during #release(String)

session - non-null, active Hibernate session that will be used to process all necessary items as well as lookup items for processing.

Throws:

GraphException

Method Detail

getTotalFoundCount

public int getTotalFoundCount()

Deprecated.

Return the total number of ids loaded into this instance.

getStep

public GraphStep getStep(int i)

Deprecated.

getOpts

public GraphOpts getOpts()

Deprecated.

getTotalProcessedCount

public int getTotalProcessedCount()

Deprecated.

Return the total number of ids which were processed. This is calculated by taking the only the completed savepoints into account.

getProcessedIds

public Set<Long> getProcessedIds(String table)

Deprecated.

Get the set of ids which were actually processed. See #addAll(String, Class, List)

addGraphIds

public void addGraphIds(GraphStep step)

Deprecated.

Add the actually processed ids to the current savepoint. It is critical that these ids are actually processed and that any failure for them to be handled will cause the entire transaction to fail (in which case these ids will be ignored).

Specified by:

addGraphIds in interface GraphStep.Callback

Throws:

GraphException - thrown if the EventLogMessage raised fails.

execute

public String execute(int j)
               throws GraphException

Deprecated.

Parameters:

step - which step is to be invoked. Running a step multiple times is not supported.

Returns:

Any warnings which were noted during execution.

Throws:

GraphException - Any errors which were caused during execution. Which execution states may be encountered is strongly tied to the definition of the specification and to the options which are passed in during initialization.

validation

public int validation()

Deprecated.

Prepares the next phase (validate(int)) by returning how many validation steps should be performed.

Returns:

validate

public String validate(int j)
                throws GraphException

Deprecated.

Parameters:

step - which step is to be invoked. Running a step multiple times is not supported.

Returns:

Any warnings which were noted during execution.

Throws:

GraphException - Any errors which were caused during execution. Which execution states may be encountered is strongly tied to the definition of the specification and to the options which are passed in during initialization.

perform

public String perform(int j,
             boolean validate)
               throws GraphException

Deprecated.

Parameters:

validate - after the proper execution of all steps has taken place, a validation call is made.

Throws:

GraphException

getClass

public Class<ome.model.IObject> getClass(String key)

Deprecated.

Specified by:

getClass in interface GraphStep.Callback

add

public void add()

Deprecated.

Specified by:

add in interface GraphStep.Callback

size

public int size()

Deprecated.

Specified by:

size in interface GraphStep.Callback

entrySet

public Iterable<Map.Entry<String,Set<Long>>> entrySet()

Deprecated.

Specified by:

entrySet in interface GraphStep.Callback

collapse

public int collapse(boolean keep)

Deprecated.

Specified by:

collapse in interface GraphStep.Callback

savepoint

public void savepoint(String savepoint)

Deprecated.

Specified by:

savepoint in interface GraphStep.Callback

release

public void release(String savepoint,
           int count)
             throws GraphException

Deprecated.

Specified by:

release in interface GraphStep.Callback

Throws:

GraphException

rollback

public void rollback(String savepoint,
            int count)
              throws GraphException

Deprecated.

Specified by:

rollback in interface GraphStep.Callback

Throws:

GraphException

toString

public String toString()

Deprecated.

Overrides:

toString in class Object