org.plasma.sdo.helper

Class PlasmaTypeHelper

java.lang.Object

org.plasma.sdo.helper.PlasmaTypeHelper

All Implemented Interfaces:

commonj.sdo.helper.TypeHelper

public class PlasmaTypeHelper
extends Object
implements commonj.sdo.helper.TypeHelper

Look up a Type given the uri and typeName or interfaceClass. SDO Types are available through the getType(uri, typeName) method. Defines Types from DataObjects.

Field Summary

Fields

Modifier and Type	Field and Description
static PlasmaTypeHelper	INSTANCE

Method Summary

Modifier and Type	Method and Description
commonj.sdo.Type	define(commonj.sdo.DataObject type) Define the DataObject as a Type.
List	define(List types) Define the list of DataObjects as Types.
commonj.sdo.Property	defineOpenContentProperty(String uri, commonj.sdo.DataObject property) Define the DataObject as a Property for setting open content.
commonj.sdo.Type	findTypeByPhysicalName(String uriPhisicalName, String typePhysicalName) Return the Type specified by physical typeName with the given physical uri, or null if not found.
commonj.sdo.Property	getOpenContentProperty(String uri, String propertyName) Get the open content (global) Property with the specified uri and name, or null if not found.
commonj.sdo.Type	getType(Class interfaceClass) Return the Type for this interfaceClass or null if not found.
commonj.sdo.Type	getType(String uri, String typeName) Return the Type specified by typeName with the given uri, or null if the underlying classifier is not found.
List<commonj.sdo.Type>	getTypes(String uri) Return the Type instances specified by the given uri.
void	releaseType(String uri, String typeName) Releases resources associated with the given type and removes it from cache.
void	releaseType(commonj.sdo.Type type) Releases resources associated with the given type and removes it from cache.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static volatile PlasmaTypeHelper INSTANCE

Method Detail

getType

public commonj.sdo.Type getType(String uri,
                                String typeName)

Return the Type specified by typeName with the given uri, or null if the underlying classifier is not found.

Specified by:

getType in interface commonj.sdo.helper.TypeHelper

Parameters:

uri - the logical uri of the Type - See Type.getURI() or PlasmaType.getURIPhysicalName();

typeName - The logical name of the Type - Type.getName() or PlasmaType.getPhysicalName();

Returns:

the Type specified by typeName with the given uri, or null if not found.

findTypeByPhysicalName

public commonj.sdo.Type findTypeByPhysicalName(String uriPhisicalName,
                                               String typePhysicalName)

Return the Type specified by physical typeName with the given physical uri, or null if not found.

Parameters:

uriPhisicalName - the physical uri of the Type - See Type.getURI() or PlasmaType.getURIPhysicalName();

typeName - The logical or physical name of the Type - Type.getName() or PlasmaType.getPhysicalName();

Returns:

the Type specified by typeName with the given uri, or null if not found.

releaseType

public void releaseType(commonj.sdo.Type type)

Releases resources associated with the given type and removes it from cache.

Parameters:

type - the type

releaseType

public void releaseType(String uri,
                        String typeName)

Releases resources associated with the given type and removes it from cache.

Parameters:

uri - The logical uri of the Type - type.getURI();

typeName - The logical name of the Type - type.getName();

getType

public commonj.sdo.Type getType(Class interfaceClass)

Return the Type for this interfaceClass or null if not found. The interfaceClass is the Java interface that follows the SDO code generation pattern.

Specified by:

getType in interface commonj.sdo.helper.TypeHelper

Parameters:

interfaceClass - is the interface for the DataObject's Type - type.getInstanceClass();

Returns:

the Type for this interfaceClass or null if not found.

Throws:

IllegalAccessException

IllegalArgumentException

getTypes

public List<commonj.sdo.Type> getTypes(String uri)

Return the Type instances specified by the given uri.

Parameters:

uri - The namespace uri;

Returns:

the Type instances specified by the given uri.

define

public commonj.sdo.Type define(commonj.sdo.DataObject type)

Define the DataObject as a Type. The Type is available through TypeHelper and DataGraph getType() methods.

Specified by:

define in interface commonj.sdo.helper.TypeHelper

Parameters:

type - the DataObject representing the Type.

Returns:

the defined Type.

Throws:

IllegalArgumentException - if the Type could not be defined.

define

public List define(List types)

Define the list of DataObjects as Types. The Types are available through TypeHelper and DataGraph getType() methods.

Specified by:

define in interface commonj.sdo.helper.TypeHelper

Parameters:

types - a List of DataObjects representing the Types.

Returns:

the defined Types.

Throws:

IllegalArgumentException - if the Types could not be defined.

defineOpenContentProperty

public commonj.sdo.Property defineOpenContentProperty(String uri,
                                                      commonj.sdo.DataObject property)

Define the DataObject as a Property for setting open content. The containing Type of the open content property is not specified by SDO. If the specified uri is not null the defined property is accessible through TypeHelper.getOpenContentProperty(uri, propertyName). If a null uri is specified, the location and management of the open content property is not specified by SDO.

Specified by:

defineOpenContentProperty in interface commonj.sdo.helper.TypeHelper

Parameters:

uri - the namespace URI of the open content Property or null.

Returns:

the defined open content Property.

Throws:

IllegalArgumentException - if the Property could not be defined.

getOpenContentProperty

public commonj.sdo.Property getOpenContentProperty(String uri,
                                                   String propertyName)

Get the open content (global) Property with the specified uri and name, or null if not found.

Specified by:

getOpenContentProperty in interface commonj.sdo.helper.TypeHelper

Parameters:

uri - the namespace URI of the open content Property.

propertyName - the name of the open content Property.

Returns:

the global Property.