org.kepler.tagging

Class Tagging

java.lang.Object

org.kepler.tagging.Tagging

public class Tagging
extends java.lang.Object

Tagging helper methods

Constructor Summary

Constructors

Constructor and Description
Tagging()

Method Summary

Modifier and Type	Method and Description
static boolean	addTag(NamedObj obj, NamedOntClass tag, PtolemyFrame ptolemyFrame) Add a tag to the named object
static java.util.Set<NamedObj>	findNamedObjects(NamedOntClass type) Search for and return named objects with the given type TODO: extend to support subclass checking
static java.util.Set<NamedObj>	findNamedObjects(java.util.Set<NamedOntClass> types) Search for and return named objects with one or more of the given types TODO: extend to support subclass checking
static java.util.Set<NamedOntClass>	getTags(java.util.Collection<NamedObj> objs)
static java.util.Set<NamedOntClass>	getTags(NamedObj obj) Get the tags for a given named object
static boolean	isAtomicallyTaggable(java.lang.Object object)
static void	main(java.lang.String[] args) Just for testing ... the findNamedObjects throws exceptions due to the object manager
static void	registerAtomicallyTaggableClass(java.lang.Class cls) If an object is tagged that is NOT an instanceof any of the classes that have been registered as atomically taggable, then the change is in limbo, and the effigy of the Kepler graph is explicitly set as changed to force a save dialog on closing.
static void	removeTag(NamedObj obj, NamedOntClass tag, boolean lastEvent) Remove a tag from the named object object
static void	removeTag(NamedObj obj, NamedOntClass tag, java.util.List<TagEventListener> listeners, boolean lastEvent)

Methods inherited from class java.lang.Object

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

Constructor Detail

Tagging

public Tagging()

Method Detail

getTags

public static java.util.Set<NamedOntClass> getTags(java.util.Collection<NamedObj> objs)

getTags

public static java.util.Set<NamedOntClass> getTags(NamedObj obj)

Get the tags for a given named object

Parameters:

obj - the named object

Returns:

the set of (possibly empty) semantic-type tags

registerAtomicallyTaggableClass

public static void registerAtomicallyTaggableClass(java.lang.Class cls)

If an object is tagged that is NOT an instanceof any of the classes that have been registered as atomically taggable, then the change is in limbo, and the effigy of the Kepler graph is explicitly set as changed to force a save dialog on closing. For example, tagging a workflow adds a semantic type that is rendered to MOML when the workflow is saved. This is not an atomic change. On the other hand, tagging a workflow run immediately adds the tag to the REAP database, so this is atomic.

Parameters:

cls - Class to register

isAtomicallyTaggable

public static boolean isAtomicallyTaggable(java.lang.Object object)

addTag

public static boolean addTag(NamedObj obj,
                             NamedOntClass tag,
                             PtolemyFrame ptolemyFrame)

Add a tag to the named object

Parameters:

obj - the named object

tag - the ontology class

ptolemyFrame - The PtolemyFrame of the current workflow we are tagging, so it can be set as modified.

Returns:

true iff a new semantic type was added successfully. false otherwise (if one of the parameters are invalid, or if obj is already tagged with tag

removeTag

public static void removeTag(NamedObj obj,
                             NamedOntClass tag,
                             java.util.List<TagEventListener> listeners,
                             boolean lastEvent)

removeTag

public static void removeTag(NamedObj obj,
                             NamedOntClass tag,
                             boolean lastEvent)

Remove a tag from the named object object

Parameters:

obj - the name object

tag - the tag

findNamedObjects

public static java.util.Set<NamedObj> findNamedObjects(java.util.Set<NamedOntClass> types)

Search for and return named objects with one or more of the given types TODO: extend to support subclass checking

Parameters:

types - the set of types to search for

Returns:

the set of matching objects

findNamedObjects

public static java.util.Set<NamedObj> findNamedObjects(NamedOntClass type)

Search for and return named objects with the given type TODO: extend to support subclass checking

Parameters:

type - the type to search for

Returns:

the set of matching objects

main

public static void main(java.lang.String[] args)

Just for testing ... the findNamedObjects throws exceptions due to the object manager

Parameters:

args - Command line arguments.