org.jahia.content

Class JahiaObject

java.lang.Object

org.jahia.content.JahiaObject

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Category

public abstract class JahiaObject
extends Object
implements Serializable

Title: Root class for all Jahia objects that use object keys and that can be instantiated through those keys.

Description: Objects should derive from this class if they may be instantiated or referenced through ObjectKey instances.

Copyright: Copyright (c) 2002

Company: Jahia Ltd

Version:

1.0

Author:

Serge Huber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectKey	objectKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JahiaObject() No arg constructor used for serialization compliance.
	JahiaObject(ObjectKey objectKey) Default constructor that sets the object's key.

Method Summary

Modifier and Type	Method and Description
static JahiaObject	getInstance(ObjectKey objectKey) Instance generator.
static JahiaObject	getInstance(ObjectKey objectKey, boolean forceLoadFromDB) Instance generator.
static Object	getInstanceAsObject(ObjectKey objectKey) Instance generator.
static Object	getInstanceAsObject(ObjectKey objectKey, boolean forceLoadFromDB) Instance generator.
ObjectKey	getObjectKey() Returns the object key that fully identifies the content object within a Jahia system.
static void	registerType(String type, String className) Registers a new type for a sub class of JahiaObject in the factory hash table.
static void	unregisterType(String type) Removes a type registration.

Methods inherited from class java.lang.Object

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

Field Detail

objectKey

protected ObjectKey objectKey

Constructor Detail

JahiaObject

public JahiaObject(ObjectKey objectKey)

Default constructor that sets the object's key.

Parameters:

objectKey - the object key that uniquely identifies this instance of JahiaObject.

JahiaObject

protected JahiaObject()

No arg constructor used for serialization compliance.

Method Detail

registerType

public static void registerType(String type,
                                String className)

Registers a new type for a sub class of JahiaObject in the factory hash table. Use this if you want to be able to create instance of the new class by using a complete content object key. The new sub class MUST implement a static method with the following signature : public static JahiaObject getChildInstance(String IDInType);

Parameters:

type - the name of the type, usually defined as a constant in the equivalent ObjectKey sub class (such as ContentPageKey)

className - the name of the class. Can be obtained with a called similar to JahiaObject.class.getName() (replacing the JahiaObject with the subclass of course.

unregisterType

public static void unregisterType(String type)

Removes a type registration. See the registerType method for more details

Parameters:

type - the name of the type to unregister

getInstance

public static JahiaObject getInstance(ObjectKey objectKey)
                               throws ClassNotFoundException

Instance generator. Build an instance of the appropriate class corresponding to the ObjectKey passed described.

Parameters:

objectKey - an ObjectKey instance for the object we want to retrieve an instance of.

Throws:

ClassNotFoundException - if no class could be found for the type passed in the object key

getInstance

public static JahiaObject getInstance(ObjectKey objectKey,
                                      boolean forceLoadFromDB)
                               throws ClassNotFoundException

Instance generator. Build an instance of the appropriate class corresponding to the ObjectKey passed described.

Parameters:

objectKey - an ObjectKey instance for the object we want to retrieve an instance of.

forceLoadFromDB - true, if object should not be returned from cache

Throws:

ClassNotFoundException - if no class could be found for the type passed in the object key

getInstanceAsObject

public static Object getInstanceAsObject(ObjectKey objectKey)
                                  throws ClassNotFoundException

Instance generator. Build an instance of the appropriate class corresponding to the ObjectKey passed described.

Parameters:

objectKey - an ObjectKey instance for the object we want to retrieve an instance of.

Throws:

ClassNotFoundException - if no class could be found for the type passed in the object key

getInstanceAsObject

public static Object getInstanceAsObject(ObjectKey objectKey,
                                         boolean forceLoadFromDB)
                                  throws ClassNotFoundException

Instance generator. Build an instance of the appropriate class corresponding to the ObjectKey passed described.

Parameters:

objectKey - an ObjectKey instance for the object we want to retrieve an instance of.

forceLoadFromDB - true, if object should not be returned from cache

Throws:

ClassNotFoundException - if no class could be found for the type passed in the object key

getObjectKey

public ObjectKey getObjectKey()

Returns the object key that fully identifies the content object within a Jahia system.

Returns:

an ObjectKey class that uniquely identifies the object.