ome.services.graphs

Interface GraphSpec

All Known Implementing Classes:

AbstractHierarchyGraphSpec, AnnotationGraphSpec, BaseGraphSpec, LightSourceGraphSpec, RenderingDefGraphSpec

Deprecated.

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

@Deprecated
public interface GraphSpec

Specification of a graph operation. These instances are defined in Spring XML files (e.g. ome/services/spec.xml) as non-singletons, i.e each time a request is made for a new GraphSpecFactory one of each GraphSpec is initialized and gathered into the factory. A single thread, then, can repeatedly call #initialize(long, Map) on the GraphSpec instances.

Since:

Beta4.2.1

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

IGraph

Method Summary

Methods

Modifier and Type	Method and Description
QueryBuilder	chgrpQuery(EventContext ec, String table, GraphOpts opts) Deprecated. Return a QueryBuilder which has been properly initialized to take the parameters "id" and "grp" and then have QueryBuilder.query(Session) called.
QueryBuilder	chmodQuery(EventContext ec, String table, GraphOpts opts) Deprecated.
QueryBuilder	deleteQuery(EventContext ec, String table, GraphOpts opts) Deprecated.
List<GraphEntry>	entries() Deprecated. Returns a copy of the list of GraphEntry instances contained in this GraphSpec
Class<ome.model.IObject>	getHibernateClass(String table) Deprecated. Return the Hibernate type (ome.model.*) for the given table.
String	getName() Deprecated. The name of this specification.
String	getSuperSpec() Deprecated. Specification of where this GraphSpec is attached under another .
ome.model.meta.ExperimenterGroup	groupInfo(ome.util.SqlAction sql) Deprecated. Like load(Session) uses the current table and id information to look up information on the given target.
int	initialize(long id, String supersec, Map<String,String> options) Deprecated. Called as each action is started.
ome.model.IObject	load(org.hibernate.Session session) Deprecated. Loads the object that this spec points to.
boolean	overrideKeep() Deprecated. For some GraphSpec type/option combinations, a "KEEP" setting may need to be overridden.
void	postProcess(org.springframework.beans.factory.ListableBeanFactory factory) Deprecated. Gives all specs a chance to reference subspecs.
long[][]	queryBackupIds(org.hibernate.Session session, int step, GraphEntry subpath, QueryBuilder and) Deprecated. If a given path is processed before its sub-path, this points to a one-to-one relationship.
Iterator<GraphSpec>	walk() Deprecated. Returns an iterator over all subspecs and their subspecs, depth-first.

Method Detail

getName

String getName()

Deprecated.

The name of this specification. Usually the first component of the entries in spec.xml

getSuperSpec

String getSuperSpec()

Deprecated.

Specification of where this GraphSpec is attached under another . The reverse of GraphEntry.getSubSpec().

postProcess

void postProcess(org.springframework.beans.factory.ListableBeanFactory factory)

Deprecated.

Gives all specs a chance to reference subspecs.

initialize

int initialize(long id,
             String supersec,
             Map<String,String> options)
               throws GraphException

Deprecated.

Called as each action is started. This instance will only be used serially (i.e. by one thread) and so this is safe. When the last step is reached, GraphState.execute(int) can take clean up actions.

Parameters:

id - identifier of the root object which defines the graph to be processed.

supersec - points to the relationship between the root object and the current graph. In many cases, this value will be null so that the current object is taken to be the root, but if this is a subspec, or a non-standard naming is being used, then the superspec will be used.

options - possibly null or empty map of options which can override the operations provided in the definition of the specification. For example, if the spec "/Image" defines "/Image/Annotation" as "HARD" (the default), then the options map could contain

 {"/Image/Annotation":"ORPHAN"}
 

to modify that setting.

Returns:

number of steps which are to be processed.

Throws:

GraphException

queryBackupIds

long[][] queryBackupIds(org.hibernate.Session session,
                      int step,
                      GraphEntry subpath,
                      QueryBuilder and)
                        throws GraphException

Deprecated.

If a given path is processed before its sub-path, this points to a one-to-one relationship. If the first object is processed without having loaded the later one, then there will be no way to find the dangling object. Therefore, we load those objects first. In the case of superspecs, we also store the root ids for the sub-spec to handle cases such as links, etc. Returns a list of all root ids per step which should be processed. These are precalculated on #initialize(long, Map) so that foreign key constraints which require a higher level object to be processed first, can be processed. For example,

 /Channel
 /Channel/StatsInfo
 

requires the Channel to be processed first, but without the Channel, there's no way to detect which StatsInfo should be removed. Therefore, #backupIds in this case would contain:

 [
  null,      # Nothing for Channel.
  [1,2,3],   # The ids of all StatsInfo object which should be removed.
 ]
 

Parameters:

paths - Non-null, non-modifiable list of all paths for the current action graph. This is used to detect if a path in some subspec is going to detach a later graph which needs then to have its ids loaded.

Throws:

GraphException

chgrpQuery

QueryBuilder chgrpQuery(EventContext ec,
                      String table,
                      GraphOpts opts)

Deprecated.

Return a QueryBuilder which has been properly initialized to take the parameters "id" and "grp" and then have QueryBuilder.query(Session) called.

chmodQuery

QueryBuilder chmodQuery(EventContext ec,
                      String table,
                      GraphOpts opts)

Deprecated.

deleteQuery

QueryBuilder deleteQuery(EventContext ec,
                       String table,
                       GraphOpts opts)

Deprecated.

walk

Iterator<GraphSpec> walk()

Deprecated.

Returns an iterator over all subspecs and their subspecs, depth-first.

overrideKeep

boolean overrideKeep()

Deprecated.

For some GraphSpec type/option combinations, a "KEEP" setting may need to be overridden. This method allows implementors to say that KEEPing must be performed on a per GraphEntry basis as opposed to for the whole subspec.

entries

List<GraphEntry> entries()

Deprecated.

Returns a copy of the list of GraphEntry instances contained in this GraphSpec

getHibernateClass

Class<ome.model.IObject> getHibernateClass(String table)

Deprecated.

Return the Hibernate type (ome.model.*) for the given table.

load

ome.model.IObject load(org.hibernate.Session session)
                       throws GraphException

Deprecated.

Loads the object that this spec points to. Performs similar logic to the queryBackupIds(Session, int, GraphEntry, QueryBuilder) but only returns the last element.

Returns:

possibly null.

Throws:

GraphException

groupInfo

ome.model.meta.ExperimenterGroup groupInfo(ome.util.SqlAction sql)

Deprecated.

Like load(Session) uses the current table and id information to look up information on the given target.