com.tibco.xp.runtime

Class Entity

java.lang.Object

com.tibco.xp.runtime.Entity

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Concept, Event

public abstract class Entity
extends java.lang.Object
implements java.io.Serializable

Concept and Event base class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INVALID_TYPE_IDENTIFIER Invalid type identifier constant

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Modifier and Type	Method and Description
protected void	assertEntity(java.lang.Boolean startRTC) Assert an entity
protected static void	checkActive() Check that the rules engine is running in this JVM
protected java.lang.String	getExtId() Get the external identifier for this entity.
protected com.tibco.cep.runtime.model.element.impl.EntityImpl	getHandle(boolean load) Get a RETE handle
static com.tibco.cep.runtime.model.element.impl.EntityImpl	getHandle(Entity entity) Get the RETE handle for an entity
long	getId() Get the unique identifier for this entity
void	load() Load an entity into working memory.
static java.util.ArrayList<com.tibco.cep.kernel.model.entity.Entity>	mapArray(Entity[] entities) Map an array of entities to their implementation objects
static Entity	mapHandle(com.tibco.cep.kernel.model.entity.Entity handle) Map a RETE handle to a managed object entity
static java.util.ArrayList<Entity>	mapHandleArray(com.tibco.cep.kernel.model.entity.Entity[] handles) Map an array of RETE handles to managed entities
protected void	register(long id) Register this entity
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_TYPE_IDENTIFIER

protected static final int INVALID_TYPE_IDENTIFIER

Invalid type identifier constant

See Also:

Constant Field Values

Constructor Detail

Entity

public Entity()

Method Detail

load

public final void load()
                throws ResourceUnavailableException

Load an entity into working memory.

The entity is not asserted, it does not cause any rules to be triggered.

Calling this method on entities that are already loaded into working memory quietly does nothing.

Throws:

ResourceUnavailableException - Rules engine not running

getId

public final long getId()

Get the unique identifier for this entity

Returns:

Entity identifier

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

assertEntity

protected void assertEntity(java.lang.Boolean startRTC)
                     throws com.tibco.cep.kernel.model.knowledgebase.DuplicateExtIdException

Assert an entity

Parameters:

startRTC - True starts an RTC. False just asserts the entity

Throws:

com.tibco.cep.kernel.model.knowledgebase.DuplicateExtIdException - Duplicated external identifier

getExtId

protected java.lang.String getExtId()

Get the external identifier for this entity.

Default implementation returns an empty string. Overridden in sub-types if they have mapped a user key to an external identifier

Returns:

Externalization identifier

register

protected final void register(long id)

Register this entity

Parameters:

id - Entity identifier

mapHandle

public static Entity mapHandle(com.tibco.cep.kernel.model.entity.Entity handle)

Map a RETE handle to a managed object entity

If the handle is dirty, shared memory is updated before returning the mapped entity.

Parameters:

handle - Handle to map. Can be null.

Returns:

Mapped entity, or null if no entity to map

mapHandleArray

public static java.util.ArrayList<Entity> mapHandleArray(com.tibco.cep.kernel.model.entity.Entity[] handles)

Map an array of RETE handles to managed entities

Parameters:

handles - Handle array to map

Returns:

Entities mapped from handle objects returned here

mapArray

public static java.util.ArrayList<com.tibco.cep.kernel.model.entity.Entity> mapArray(Entity[] entities)

Map an array of entities to their implementation objects

Parameters:

entities - Entity array to map

Returns:

Entity implementations mapped from entity objects

checkActive

protected static void checkActive()

Check that the rules engine is running in this JVM

getHandle

public static com.tibco.cep.runtime.model.element.impl.EntityImpl getHandle(Entity entity)

Get the RETE handle for an entity

N.B. - this method is static so that it isn't dispatched on remote objects since it is accessing local POJOs

Parameters:

entity - Entity for which to get associated handle object. May be null.

Returns:

RETE handle, or null.

getHandle

protected final com.tibco.cep.runtime.model.element.impl.EntityImpl getHandle(boolean load)

Get a RETE handle

Parameters:

load - True if handle should be loaded into working memory if not already loaded, false do not load into working memory.

Returns:

RETE handle