org.kepler.sms

Class SMSServices

java.lang.Object

org.kepler.sms.SMSServices

public class SMSServices
extends java.lang.Object

This class provides a set of operations, or services for interacting with the Semantic Mediation System. These services are currently only partially defined.

Since:

Kepler alpha

Author:

Shawn Bowers

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPATIBLE
static int	INCOMPATIBLE
static int	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SMSServices()

Method Summary

Modifier and Type	Method and Description
static void	addListener(SMSTagChangeListener listener)
static int	compare(java.util.Vector semSubtypes, java.util.Vector semSupertypes) Compare the compatibility of the two sets of semantic types.
static boolean	compatible(java.util.Vector semSubtypes, java.util.Vector semSupertypes)
static java.lang.String	exportSemanticAnnotation(Entity entity)
static java.util.Vector<SemanticType>	getActorSemanticTypes(NamedObj obj)
static java.util.Vector<java.lang.Object>	getAllInputPorts(NamedObj obj)
static java.util.Vector<SemanticType>	getAllInputSemanticTypes(NamedObj obj) Return all the input semantic types for the object.
static java.util.Vector<java.lang.Object>	getAllOutputPorts(NamedObj obj)
static java.util.Vector<SemanticType>	getAllOutputSemanticTypes(NamedObj obj) Return all the input semantic types for the object.
static java.util.Vector<java.lang.Object>	getAllPorts(NamedObj obj) Get all the ports, both "real" and "virtual" from a given named object.
static java.util.Vector<java.lang.Object>	getIOPorts(NamedObj obj) Get all the io ports
static NamedOntClass	getNamedOntClassFor(SemanticType semtype)
static NamedOntClass	getNamedOntClassFor(java.lang.String conceptId)
static java.util.Vector<java.lang.Object>	getPortBundles(NamedObj obj) Get all the port bundles define for a given named object.
static java.util.Vector<SemanticType>	getPortSemanticTypes(java.lang.Object port) Given a port object (TODO: convert to IOPortWrapper), returns the semantic types assigned to the port.
static java.util.Vector<java.lang.Object>	getRefinementPorts(NamedObj obj) Get all the existing refinement ports defiend for a given named object.
static void	importSemanticAnnotation(java.lang.String annotation, Entity entity)
static void	removeListener(SMSTagChangeListener listener)
static void	setActorSemanticTypes(NamedObj obj, java.util.Vector<NamedOntClass> namedOntClasses) Set given NamedObj's SemanticTypes to namedOntClasses

Methods inherited from class java.lang.Object

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

Field Detail

COMPATIBLE

public static int COMPATIBLE

UNKNOWN

public static int UNKNOWN

INCOMPATIBLE

public static int INCOMPATIBLE

Constructor Detail

SMSServices

public SMSServices()

Method Detail

addListener

public static void addListener(SMSTagChangeListener listener)

removeListener

public static void removeListener(SMSTagChangeListener listener)

compare

public static int compare(java.util.Vector semSubtypes,
                          java.util.Vector semSupertypes)

Compare the compatibility of the two sets of semantic types. Both arguements represent conjoined sets of semantic types. The method returns three possible values: compatible, unknown, or incompatible. If either type is empty, unknown is returned. The types are considered compatible if they are non-empty and if the conjunction of the first set implies the conjunction of the second set. The types are considered incompatible if they are not compatible and not unkown.

Parameters:

semSubtypes - The semantic types that when conjoined form a sub-class of the super type (semSupertypes).

semSupertypes - The semantic types that when conjoined form a super-class of the sub type (subSemTypes)

Returns:

Answers COMPATIBLE if the inputs are compatible, UNKNOWN if the inputs are unkown, and INCOMPATIBLE if the types are incompatible. FIXME: Need to somehow handle the case when the semtype is not available locally: Can we assume they are known here? Do we need to call the object manager? Do we throw an exception? For now, we just ignore them!

compatible

public static boolean compatible(java.util.Vector semSubtypes,
                                 java.util.Vector semSupertypes)

getNamedOntClassFor

public static NamedOntClass getNamedOntClassFor(SemanticType semtype)

getNamedOntClassFor

public static NamedOntClass getNamedOntClassFor(java.lang.String conceptId)

getActorSemanticTypes

public static java.util.Vector<SemanticType> getActorSemanticTypes(NamedObj obj)

setActorSemanticTypes

public static void setActorSemanticTypes(NamedObj obj,
                                         java.util.Vector<NamedOntClass> namedOntClasses)

Set given NamedObj's SemanticTypes to namedOntClasses

Parameters:

obj - The named object (actor) to set the types on

namedOntClasses - Set named object's SemanticTypes to these

getAllPorts

public static java.util.Vector<java.lang.Object> getAllPorts(NamedObj obj)

Get all the ports, both "real" and "virtual" from a given named object.

Parameters:

obj - the named object

Returns:

the set of ports for the object TODO: Return as IOPortWrapper objects

getAllOutputPorts

public static java.util.Vector<java.lang.Object> getAllOutputPorts(NamedObj obj)

getAllInputPorts

public static java.util.Vector<java.lang.Object> getAllInputPorts(NamedObj obj)

getIOPorts

public static java.util.Vector<java.lang.Object> getIOPorts(NamedObj obj)

Get all the io ports

Parameters:

obj - the named object

Returns:

the set of ports for the object TODO: Return as IOPortWrapper objects

getRefinementPorts

public static java.util.Vector<java.lang.Object> getRefinementPorts(NamedObj obj)

Get all the existing refinement ports defiend for a given named object.

Parameters:

obj - the named object

Returns:

the set of ports for the object TODO: Return as IOPortWrapper objects

getPortBundles

public static java.util.Vector<java.lang.Object> getPortBundles(NamedObj obj)

Get all the port bundles define for a given named object.

Parameters:

obj - the named object

Returns:

the set of ports for the object TODO: Return as IOPortWrapper objects

getPortSemanticTypes

public static java.util.Vector<SemanticType> getPortSemanticTypes(java.lang.Object port)

Given a port object (TODO: convert to IOPortWrapper), returns the semantic types assigned to the port.

Parameters:

port - the port object

Returns:

a set of semantic type objects

getAllOutputSemanticTypes

public static java.util.Vector<SemanticType> getAllOutputSemanticTypes(NamedObj obj)

Return all the input semantic types for the object.

getAllInputSemanticTypes

public static java.util.Vector<SemanticType> getAllInputSemanticTypes(NamedObj obj)

Return all the input semantic types for the object.

exportSemanticAnnotation

public static java.lang.String exportSemanticAnnotation(Entity entity)

importSemanticAnnotation

public static void importSemanticAnnotation(java.lang.String annotation,
                                            Entity entity)