ome.services.graphs

Class AbstractHierarchyGraphSpec

java.lang.Object

ome.services.graphs.BaseGraphSpec

ome.services.graphs.AbstractHierarchyGraphSpec

All Implemented Interfaces:

GraphSpec, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

AnnotationGraphSpec, LightSourceGraphSpec

Deprecated.

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

@Deprecated
public abstract class AbstractHierarchyGraphSpec
extends BaseGraphSpec

GraphSpec specialized for processing hierarchies of other types. Adds options for which classes to process.

Since:

4.4.4

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

IGraph, ticket:9435

Nested Class Summary

Nested classes/interfaces inherited from class ome.services.graphs.BaseGraphSpec

BaseGraphSpec.SubSpecIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean[]	isAbstract Deprecated. Whether or not the type of types[i] is abstract.
protected String[]	optSource Deprecated. Key from the options map which was the source of the rawOption value of the same index.
protected String[]	rawOption Deprecated. Original string contained in the options Map before parsing.
protected Class<?>[]	types Deprecated. Type of each sub-step.

Fields inherited from class ome.services.graphs.BaseGraphSpec

em, entries, id, options, superspec

Constructor Summary

Constructors

Constructor and Description
AbstractHierarchyGraphSpec(List<String> entries) Deprecated. Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Class	getRoot() Deprecated. Return the root class for this hierarchy.
protected abstract <T> Set<Class<T>>	getTypes(ExtendedMetadata em) Deprecated. Returns all the types that are known for this hierarchy.
protected abstract void	handleOptions(int i, String[] parts) Deprecated. Called once per loop iteration throw rawOptions during initialize(long, String, Map)
int	initialize(long id, String superspec, Map<String,String> dontmodify) Deprecated. In order to allow subclasses like the AnnotationGraphSpec to make use of this method, hooks have been added.
protected abstract boolean	isOverrideKeep(int step, QueryBuilder and, String alias) Deprecated. If BaseGraphSpec.overrideKeep() returns true for a subclass, then this method will likely want to (at least sometimes) return a true value.
protected abstract void	postProcessOptions() Deprecated. If any options exist, this method will be called to finalize any of the processing done by handleOptions(int, String[]).
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.
void	setExtendedMetadata(ExtendedMetadata em) Deprecated. Performs sanity checks on the entries found in ExtendedMetadata.

Methods inherited from class ome.services.graphs.BaseGraphSpec

buildQuery, chgrpQuery, chmodQuery, createQueryBuilder, deleteQuery, entries, getHibernateClass, getName, getSuperSpec, groupInfo, join, joinDataset, joinPlate, load, overrideKeep, parseResults, permissionsClause, postProcess, runQuery, setBeanName, toString, walk, walk

Methods inherited from class java.lang.Object

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

Field Detail

isAbstract

protected final boolean[] isAbstract

Deprecated.

Whether or not the type of types[i] is abstract. If true, no processing will take place, since otherwise duplicate multiple actions would be attempted for each id.

types

protected final Class<?>[] types

Deprecated.

Type of each sub-step. TheSuperClass.class.isAssignableFrom(types[i]) is true.

rawOption

protected final String[] rawOption

Deprecated.

Original string contained in the options Map before parsing. The value may come from one of several sources, e.g. for a FileAnnotation the keys checked are:

     /abspath/FileAnnotation
     /FileAnnotation
     /abspath/TypeAnnotation
     /TypeAnnotation
     /abspath/Annotation
     /Annotation
 

optSource

protected final String[] optSource

Deprecated.

Key from the options map which was the source of the rawOption value of the same index. I.e. if rawOption[2] contains "KEEP", then optSource[2] should point to an entry in options which equals "KEEP".

Constructor Detail

AbstractHierarchyGraphSpec

public AbstractHierarchyGraphSpec(List<String> entries)

Deprecated.

Creates a new instance.

Parameters:

entries - The entries to handle.

Method Detail

getRoot

protected abstract Class getRoot()

Deprecated.

Return the root class for this hierarchy.

getTypes

protected abstract <T> Set<Class<T>> getTypes(ExtendedMetadata em)

Deprecated.

Returns all the types that are known for this hierarchy.

setExtendedMetadata

public void setExtendedMetadata(ExtendedMetadata em)

Deprecated.

Performs sanity checks on the entries found in ExtendedMetadata. Primarily, this prevents new types from not being properly specified in spec.xml.

Overrides:

setExtendedMetadata in class BaseGraphSpec

initialize

public int initialize(long id,
             String superspec,
             Map<String,String> dontmodify)
               throws GraphException

Deprecated.

In order to allow subclasses like the AnnotationGraphSpec to make use of this method, hooks have been added.

Specified by:

initialize in interface GraphSpec

Overrides:

initialize in class BaseGraphSpec

Parameters:

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

superspec - 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.

dontmodify - 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

See Also:

handleOptions(int, String[])

handleOptions

protected abstract void handleOptions(int i,
                 String[] parts)

Deprecated.

Called once per loop iteration throw rawOptions during initialize(long, String, Map)

Parameters:

i - Index into rawOption which is being processed.

parts - semi-colon split values of rawOptions[i]

postProcessOptions

protected abstract void postProcessOptions()

Deprecated.

If any options exist, this method will be called to finalize any of the processing done by handleOptions(int, String[]).

queryBackupIds

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

Deprecated.

Description copied from interface: GraphSpec

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.
 ]
 

Specified by:

queryBackupIds in interface GraphSpec

Overrides:

queryBackupIds in class BaseGraphSpec

Throws:

GraphException

isOverrideKeep

protected abstract boolean isOverrideKeep(int step,
                     QueryBuilder and,
                     String alias)

Deprecated.

If BaseGraphSpec.overrideKeep() returns true for a subclass, then this method will likely want to (at least sometimes) return a true value. When it returns true, then it should also modify the QueryBuilder in order to properly filter for only those objects of interest. If a false is returned, then no IDs will be queried for this entity.