org.rapidcontext.core.type

Class Type

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.type.Type

public class Type
extends StorableObject

The object type initializer. This class maps type and Java class mappings found in the storage to the actual storage type registry. Since this type mapping class is itself uses the storage object initialization feature, it will register itself twice (once for bootstrapping and once from the proper storage file).

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_DESCRIPTION The dictionary key for the description text.
static java.lang.String	KEY_INITIALIZER The dictionary key for the initializer class name.
static java.lang.String	KEY_PROPERTY The dictionary key for the property array.
static Path	PATH The connection object storage path.

Fields inherited from class org.rapidcontext.core.storage.StorableObject

dict, KEY_CLASSNAME, KEY_ID, KEY_TYPE

Constructor Summary

Constructors

Constructor and Description
Type(java.lang.String id, java.lang.String type, Dict dict) Creates a new type mapping from a serialized representation.

Method Summary

Modifier and Type	Method and Description
static java.lang.reflect.Constructor	constructor(Storage storage, Dict dict) Returns a constructor for creating a Java object instance.
java.lang.String	description() Returns the type description.
static Type	find(Storage storage, java.lang.String id) Searches for a specific type in the storage.
static Type[]	findAll(Storage storage) Searches for all types in the storage.
protected void	init() Initializes this type mapping by registering it via the methods in the Storage class.
java.lang.Class	initializer() Returns the type initializer class.
protected static java.lang.Class	loadClass(java.lang.String className, java.lang.String objId) Loads and returns a specified class.
Type	parentType(Storage storage) Searches for the parent type in the type hierarchy.
Array	properties() Returns an array of type properties.

Methods inherited from class org.rapidcontext.core.storage.StorableObject

activate, destroy, id, isActive, isModified, passivate, path, serialize, toString, type

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DESCRIPTION

public static final java.lang.String KEY_DESCRIPTION

The dictionary key for the description text.

See Also:

Constant Field Values

KEY_INITIALIZER

public static final java.lang.String KEY_INITIALIZER

The dictionary key for the initializer class name.

See Also:

Constant Field Values

KEY_PROPERTY

public static final java.lang.String KEY_PROPERTY

The dictionary key for the property array.

See Also:

Constant Field Values

PATH

public static final Path PATH

The connection object storage path.

Constructor Detail

Type

public Type(java.lang.String id,
            java.lang.String type,
            Dict dict)

Creates a new type mapping from a serialized representation.

Parameters:

id - the object identifier

type - the object type name

dict - the serialized representation

Method Detail

find

public static Type find(Storage storage,
                        java.lang.String id)

Searches for a specific type in the storage.

Parameters:

storage - the storage to search in

id - the type identifier

Returns:

the type found, or null if not found

findAll

public static Type[] findAll(Storage storage)

Searches for all types in the storage.

Parameters:

storage - the storage to search in

Returns:

an array of all types found

constructor

public static java.lang.reflect.Constructor constructor(Storage storage,
                                                        Dict dict)

Returns a constructor for creating a Java object instance. If no object type or initializer was found, or if an error occurred, null is returned. This method will lookup the corresponding type in the storage dynamically.

Parameters:

storage - the storage to use for type lookups

dict - the dictionary data

Returns:

the Java object constructor, or null if not found

loadClass

protected static java.lang.Class loadClass(java.lang.String className,
                                           java.lang.String objId)

Loads and returns a specified class.

Parameters:

className - the fully qualified class name to load

objId - the object identifier for logging

Returns:

the class found in the class loader, or null if not found

init

protected void init()
             throws StorageException

Initializes this type mapping by registering it via the methods in the Storage class.

Overrides:

init in class StorableObject

Throws:

StorageException - if the initialization failed

description

public java.lang.String description()

Returns the type description.

Returns:

the type description

initializer

public java.lang.Class initializer()

Returns the type initializer class.

Returns:

the type initializer class

properties

public Array properties()

Returns an array of type properties. Each property should be a dictionary object containing property information. Note that parent type properties are normally also applicable, but must be retrieved separately.

Returns:

the array of type properties, or an empty array if it didn't exist

parentType

public Type parentType(Storage storage)

Searches for the parent type in the type hierarchy. A parent type normally declares additional properties that may or may not be applicable also for this type.

Parameters:

storage - the storage to search in

Returns:

the parent type, or null if not found