ome.services.graphs

Class AnnotationGraphSpec

java.lang.Object

ome.services.graphs.BaseGraphSpec

ome.services.graphs.AbstractHierarchyGraphSpec

ome.services.graphs.AnnotationGraphSpec

All Implemented Interfaces:

GraphSpec, org.springframework.beans.factory.BeanNameAware

Deprecated.

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

@Deprecated
public class AnnotationGraphSpec
extends AbstractHierarchyGraphSpec

AbstractHierarchyGraphSpec specialized for processing annotations. Adds options for which namespaces to process.

Since:

Beta4.2.1

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

IGraph

Nested Class Summary

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

BaseGraphSpec.SubSpecIterator

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	nsExcludes Deprecated. Collection of namespace values (defined as nsIncludes) which will be omitted from processing by default.
static Set<String>	nsIncludes Deprecated. Collection of namespace values (or LIKE values if they contain '%' or '?')

Fields inherited from class ome.services.graphs.AbstractHierarchyGraphSpec

isAbstract, optSource, rawOption, types

Fields inherited from class ome.services.graphs.BaseGraphSpec

em, entries, id, options, superspec

Constructor Summary

Constructors

Constructor and Description
AnnotationGraphSpec(List<String> entries) Deprecated. Creates a new instance.
AnnotationGraphSpec(Map<String,String> excludeMap, List<String> entries) Deprecated. Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getExclude(int step) Deprecated. Returns the value from "...
protected Class	getRoot() Deprecated. Return the root class for this hierarchy.
protected Set<Class<ome.model.annotations.Annotation>>	getTypes(ExtendedMetadata em) Deprecated. Returns all the types that are known for this hierarchy.
protected void	handleOptions(int i, String[] parts) Deprecated. Called once per loop iteration throw rawOptions during AbstractHierarchyGraphSpec.initialize(long, String, Map)
protected 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.
boolean	overrideKeep() Deprecated. Returns true to prevent skipping of the entire subspec if there were any "excludes" passed in with the options.
protected void	postProcessOptions() Deprecated. If any options exist, this method will be called to finalize any of the processing done by AbstractHierarchyGraphSpec.handleOptions(int, String[]).

Methods inherited from class ome.services.graphs.AbstractHierarchyGraphSpec

initialize, queryBackupIds, setExtendedMetadata

Methods inherited from class ome.services.graphs.BaseGraphSpec

buildQuery, chgrpQuery, chmodQuery, createQueryBuilder, deleteQuery, entries, getHibernateClass, getName, getSuperSpec, groupInfo, join, joinDataset, joinPlate, load, 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

nsIncludes

public static final Set<String> nsIncludes

Deprecated.

Collection of namespace values (or LIKE values if they contain '%' or '?') which will be included by default.

nsExcludes

public static final Set<String> nsExcludes

Deprecated.

Collection of namespace values (defined as nsIncludes) which will be omitted from processing by default.

Constructor Detail

AnnotationGraphSpec

public AnnotationGraphSpec(List<String> entries)

Deprecated.

Creates a new instance.

Parameters:

entries - The entries to handle.

AnnotationGraphSpec

public AnnotationGraphSpec(Map<String,String> excludeMap,
                   List<String> entries)

Deprecated.

Creates a new instance.

Parameters:

excludeMap - The namespaces to exclude.

entries - The entries to handle.

Method Detail

getExclude

public String getExclude(int step)

Deprecated.

Returns the value from "...;excludes=VALUEHERE" parsed out of the options map during #initialize(long, String, Map). Used primarily for testing.

getRoot

protected Class getRoot()

Deprecated.

Description copied from class: AbstractHierarchyGraphSpec

Return the root class for this hierarchy.

Specified by:

getRoot in class AbstractHierarchyGraphSpec

getTypes

protected Set<Class<ome.model.annotations.Annotation>> getTypes(ExtendedMetadata em)

Deprecated.

Description copied from class: AbstractHierarchyGraphSpec

Returns all the types that are known for this hierarchy.

Specified by:

getTypes in class AbstractHierarchyGraphSpec

handleOptions

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

Deprecated.

Description copied from class: AbstractHierarchyGraphSpec

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

Specified by:

handleOptions in class AbstractHierarchyGraphSpec

Parameters:

i - Index into AbstractHierarchyGraphSpec.rawOption which is being processed.

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

postProcessOptions

protected void postProcessOptions()

Deprecated.

Description copied from class: AbstractHierarchyGraphSpec

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

Specified by:

postProcessOptions in class AbstractHierarchyGraphSpec

overrideKeep

public boolean overrideKeep()

Deprecated.

Returns true to prevent skipping of the entire subspec if there were any "excludes" passed in with the options. These namespaces must be processed anyway.

Specified by:

overrideKeep in interface GraphSpec

Overrides:

overrideKeep in class BaseGraphSpec

isOverrideKeep

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

Deprecated.

Description copied from class: AbstractHierarchyGraphSpec

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.

Specified by:

isOverrideKeep in class AbstractHierarchyGraphSpec