ome.services.graphs

Class GraphStep

java.lang.Object

ome.services.graphs.GraphStep

Direct Known Subclasses:

ChgrpStep, ChownStep, DeleteStep, ExporterStep

Deprecated.

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

@Deprecated
public abstract class GraphStep
extends Object

Single action performed by GraphState.

Since:

Beta4.2.3

Author:

Josh Moore, josh at glencoesoftware.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GraphStep.Callback Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
EventContext	ec Deprecated. An event context which has been initialized for a particular group, i.e.
protected ExtendedMetadata	em Deprecated.
GraphEntry	entry Deprecated. GraphEntry instance which is active for this step.
long	id Deprecated. The actual id to be processed as opposed to GraphEntry.getId() which is the id of the root object.
int	idx Deprecated. Location of this step in GraphState.steps.
Class<ome.model.IObject>	iObjectType Deprecated. Type of object which is being processed, using during GraphState#release(String) to send an EventLogMessage.
GraphStep	parent Deprecated. Final member of stack which is the direct ancestor of this step.
String	pathMsg Deprecated. String representation of the path to this GraphEntry used for logging.
GraphSpec	spec Deprecated. GraphSpec instance which is active for this step.
LinkedList<GraphStep>	stack Deprecated. Stack of other GraphStep instances which show where this step is in the entire graph.
String	table Deprecated. Parsed table name used for the SQL/HQL statements.

Constructor Summary

Constructors

Constructor and Description
GraphStep(ExtendedMetadata em, int idx, List<GraphStep> stack, GraphSpec spec, GraphEntry entry, long[] ids) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	action(GraphStep.Callback cb, org.hibernate.Session session, ome.util.SqlAction sql, GraphOpts opts) Deprecated. Primary action which should perform the main modifications required by the step.
protected void	deleteAnnotationLinks(AnnotationGraphSpec aspec, org.hibernate.Session session, List<Long> ids) Deprecated.
protected List<Long>	findImproperIncomingLinks(org.hibernate.Session session, String[] lock) Deprecated.
long[]	getIds() Deprecated. Currently returns the ID array without copying therefore values should not be leaked to code outside of the ome.services.graphs hierarchy.
protected void	graphValidation(org.hibernate.Session session) Deprecated. Immediately we check that an object moved from GroupA to GroupB is no longer pointed at by any objects in GroupA via foreign key constraints.
boolean	hasSavepoint() Deprecated.
protected void	logPhase(String phase) Deprecated.
protected void	logResults(int count) Deprecated.
abstract void	onRelease(Class<ome.model.IObject> k, Set<Long> ids) Deprecated.
protected void	optionallyNullField(org.hibernate.Session session, Long id) Deprecated.
protected QueryBuilder	optionalNullBuilder() Deprecated.
void	pop(GraphOpts opts) Deprecated.
void	push(GraphOpts opts) Deprecated.
void	release(GraphStep.Callback cb) Deprecated.
void	rollback(GraphStep.Callback cb) Deprecated.
void	rollbackOnly() Deprecated.
String	savepoint(GraphStep.Callback cb) Deprecated.
void	setEventContext(EventContext ec) Deprecated.
String	start(GraphStep.Callback cb) Deprecated.
void	validate(GraphState graphState, org.hibernate.Session session, ome.util.SqlAction sql, GraphOpts opts) Deprecated. Action performed at the end of the transaction to give all rows the chance to invalidate other actions.
void	validation() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

em

protected final ExtendedMetadata em

Deprecated.

idx

public final int idx

Deprecated.

Location of this step in GraphState.steps.

stack

public final LinkedList<GraphStep> stack

Deprecated.

Stack of other GraphStep instances which show where this step is in the entire graph.

parent

public final GraphStep parent

Deprecated.

Final member of stack which is the direct ancestor of this step.

spec

public final GraphSpec spec

Deprecated.

GraphSpec instance which is active for this step.

entry

public final GraphEntry entry

Deprecated.

GraphEntry instance which is active for this step.

id

public final long id

Deprecated.

The actual id to be processed as opposed to GraphEntry.getId() which is the id of the root object.

See Also:

ids

table

public final String table

Deprecated.

Parsed table name used for the SQL/HQL statements.

iObjectType

public final Class<ome.model.IObject> iObjectType

Deprecated.

Type of object which is being processed, using during GraphState#release(String) to send an EventLogMessage.

pathMsg

public final String pathMsg

Deprecated.

String representation of the path to this GraphEntry used for logging.

ec

public EventContext ec

Deprecated.

An event context which has been initialized for a particular group, i.e. even we are currently in an omero.group=-1 context, the group of the object in question will be returned by EventContext.getCurrentGroupId(). See 8723

Constructor Detail

GraphStep

public GraphStep(ExtendedMetadata em,
         int idx,
         List<GraphStep> stack,
         GraphSpec spec,
         GraphEntry entry,
         long[] ids)

Deprecated.

Method Detail

setEventContext

public void setEventContext(EventContext ec)

Deprecated.

getIds

public long[] getIds()

Deprecated.

Currently returns the ID array without copying therefore values should not be leaked to code outside of the ome.services.graphs hierarchy. Non-copying is primarily intended to reduce GC overhead.

action

public abstract void action(GraphStep.Callback cb,
          org.hibernate.Session session,
          ome.util.SqlAction sql,
          GraphOpts opts)
                     throws GraphException

Deprecated.

Primary action which should perform the main modifications required by the step.

Throws:

GraphException

validate

public void validate(GraphState graphState,
            org.hibernate.Session session,
            ome.util.SqlAction sql,
            GraphOpts opts)
              throws GraphException

Deprecated.

Action performed at the end of the transaction to give all rows the chance to invalidate other actions.

Parameters:

graphState -

session -

sql -

opts -

Throws:

GraphException

logPhase

protected void logPhase(String phase)

Deprecated.

logResults

protected void logResults(int count)

Deprecated.

push

public void push(GraphOpts opts)
          throws GraphException

Deprecated.

Throws:

GraphException

pop

public void pop(GraphOpts opts)

Deprecated.

rollbackOnly

public void rollbackOnly()

Deprecated.

hasSavepoint

public boolean hasSavepoint()

Deprecated.

validation

public void validation()

Deprecated.

start

public String start(GraphStep.Callback cb)
             throws GraphException

Deprecated.

Throws:

GraphException

savepoint

public String savepoint(GraphStep.Callback cb)

Deprecated.

release

public void release(GraphStep.Callback cb)
             throws GraphException

Deprecated.

Throws:

GraphException

onRelease

public abstract void onRelease(Class<ome.model.IObject> k,
             Set<Long> ids)
                        throws GraphException

Deprecated.

Throws:

GraphException

rollback

public void rollback(GraphStep.Callback cb)
              throws GraphException

Deprecated.

Throws:

GraphException

graphValidation

protected void graphValidation(org.hibernate.Session session)
                        throws GraphConstraintException

Deprecated.

Immediately we check that an object moved from GroupA to GroupB is no longer pointed at by any objects in GroupA via foreign key constraints. This is what the DB does for us inherently on delete. NB: After all objects are moved, we need to perform the reverse check, which is that no object in GroupB points at any objects in GroupA, i.e. all necessary objects were moved.

Parameters:

session -

Throws:

GraphConstraintException

See Also:

ticket:6442

findImproperIncomingLinks

protected List<Long> findImproperIncomingLinks(org.hibernate.Session session,
                                   String[] lock)

Deprecated.

deleteAnnotationLinks

protected void deleteAnnotationLinks(AnnotationGraphSpec aspec,
                         org.hibernate.Session session,
                         List<Long> ids)

Deprecated.

optionalNullBuilder

protected QueryBuilder optionalNullBuilder()

Deprecated.

optionallyNullField

protected void optionallyNullField(org.hibernate.Session session,
                       Long id)

Deprecated.