ManagedObject (TIBCO ActiveSpaces(R) Transactions)

java.lang.Object
- com.kabira.platform.ManagedObject

@Managed
public class ManagedObject
extends java.lang.Object

Class to manipulate and find shared memory backed objects. To create a Java object that persists in shared memory, see the @Managed annotation.

Example:

@Managed
public class Account {
    public Account(String userName) {
    super();
    m_userName = userName;
    }

    public Account(String userName, Account referrer) {
    this(userName);
    allocateMailbox();
    addToFriendList(referrer);
    }

    public void addToFriendList(Account friendlyAccount) {
    ...
    }

    private void allocateMailbox() {
    ...
    }

    private String m_userName;
    private Account[] m_friendList;
}

Some example usage of the above type:

    //
    //  create a new account in shared memory:
    //
    Account newCustomer = new Account("Fred Rogers", referrer);
    System.out.println("Added " + newCustomer.toString());

    //
    //  delete all expired accounts from shared memory.
    //  Note extent access, and use of the delete() method
    //  to delete the shared memory instance.
    //
    for (Account acc : ManagedObject.extent(Account.class)) {
    if (acc.expireDate < today) {
        ManagedObject.delete(acc);
    }
    }

See Also:: Managed, Transaction

Constructor Summary

Constructors
Constructor and Description

ManagedObject()

Constructors
Constructor and Description
`ManagedObject()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`cardinality(java.lang.Class<?> klass)` Returns the number of instances of the given class.
`static int`	`cardinality(java.lang.Class<?> klass, QueryScope queryScope)` Returns the number of instances of the given class.
`static void`	`delete(java.lang.Object operand)` Deletes a Managed object.
`static boolean`	`equals(java.lang.Object o1, java.lang.Object o2)` Returns true if both references are proxies to the same shared memory object.
`static <T> java.lang.Iterable<T>`	`extent(java.lang.Class<T> klass)` Returns all shared memory instances of a Managed type.
`static <T> java.lang.Iterable<T>`	`extent(java.lang.Class<T> klass, LockMode objectLock)` Returns all shared memory instances of a Managed type, with an explicit transaction lock taken on each instance as it is iterated.
`static <T> java.lang.Iterable<T>`	`extent(java.lang.Class<T> klass, QueryScope queryScope, LockMode objectLock)` Returns all shared memory instances of a Managed type, with an explicit transaction lock taken on each instance as it is iterated.
`static byte[]`	`getObjectReference(java.lang.Object o)` Return the object reference as a byte array.
`static int`	`hashCode(java.lang.Object o)` Returns a hash code based on the underlying shared memory object.
`static boolean`	`isEmpty(java.lang.Object operand)` Determines if the backing shared memory object has been deleted.
`static boolean`	`isManaged(java.lang.Object o)` Determines if the given object is an instance of a Managed class.
`static boolean`	`isManagedClass(java.lang.Class<?> klass)` Determines if the given class is Managed.
`static boolean`	`isPartitioned(java.lang.Class<?> klass)` Determines if the given class is partitioned.
`static java.lang.String`	`objectToReference(java.lang.Object operand)` Get a string version of an object reference
`static java.lang.Object`	`referenceToObject(java.lang.String refStr)` Convert a stringified object reference to an Object
`static void`	`setDistributedQuery(com.kabira.platform.DistributedQuery distributedQuery)` Internal method - do not use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ManagedObject
```
public ManagedObject()
```
- Method Detail
  - extent
```
public static <T> java.lang.Iterable<T> extent(java.lang.Class<T> klass)
                                        throws ManagedClassError
```
    Returns all shared memory instances of a Managed type.
    The klass parameter must be a Managed class, and is used to determine the extent to return. A Managed class is either annotated @Managed, or extends a class that is so annotated.
    Consider the following example. It returns all instances of MyType (including instances of its subtypes) with no locks held on the objects:
```
    //
    // Iterate instances of MyType.class, returning all objects in the extent
    //
    for (MyType instance : ManagedObject.extent(MyType.class)) {
    assert ( Transaction.hasReadLock(instance) == false );
    assert ( Transaction.hasWriteLock(instance) == false );
    ...
    }
```
    Type Parameters:
    
    T - Managed class.
    
    Parameters:
    
    klass - extent class - instances of this type, and any subtypes that extend from this type, will be returned in the extent.
    
    Returns:
    
    Iterable that will traverse all instances located in shared memory.
    
    Throws:
    
    ManagedClassError - Thrown if klass is not Managed (or exactly ManagedObject).
    
    See Also:
    
    Managed, ManagedClassError
  - extent
```
public static <T> java.lang.Iterable<T> extent(java.lang.Class<T> klass,
                                               LockMode objectLock)
                                        throws ManagedClassError
```
    Returns all shared memory instances of a Managed type, with an explicit transaction lock taken on each instance as it is iterated.
    The klass parameter must be a Managed class, and is used to determine the extent to return.
    The objectLock parameter is used to specify the transaction lock to take on objects returned during extent iteration. The objects are locked as they are returned from the java.util.Iterator, not when this method returns.
    Consider the following example. It returns all instances of MyType (including instances of its subtypes) with a READLOCK held on each instance:
```
    //
    //  Iterate the ManagedObjectSet taking read locks on the objects
    //
    for (MyType mt : ManagedObject.extent( MyType.class, LockMode.READLOCK)) {
    assert ( Transaction.hasReadLock(mt) == true );
    ...
    }
```
    Type Parameters:
    
    T - Managed class.
    
    Parameters:
    
    klass - extent class - instances of this type, and any subtypes that extend from this type, will be returned in the extent.
    
    objectLock - object lock - all object instances returned during extent iteration will have this transaction lock.
    
    Returns:
    
    Iterable containing references to all instances located in shared memory.
    
    Throws:
    
    ManagedClassError - Thrown if klass is not marked Managed, or is exactly ManagedObject.
    
    See Also:
    
    Managed
  - extent
```
public static <T> java.lang.Iterable<T> extent(java.lang.Class<T> klass,
                                               QueryScope queryScope,
                                               LockMode objectLock)
                                        throws ManagedClassError,
                                               java.lang.IllegalArgumentException,
                                               ResourceUnavailableException
```
    Returns all shared memory instances of a Managed type, with an explicit transaction lock taken on each instance as it is iterated.
    The klass parameter must be a Managed class, and is used to determine the extent to return.
    The queryScope parameter determines the scope of the search for object instances.
    The objectLock parameter is used to specify the transaction lock to take on objects returned during extent iteration. The objects are locked as they are returned from the java.util.Iterator, not when this method returns.
    
    Type Parameters:
    
    T - Managed class.
    
    Parameters:
    
    klass - extent class - instances of this type, and any subtypes that extend from this type, will be returned in the extent.
    
    queryScope - scope of extent lookup.
    
    objectLock - object lock - all object instances returned during extent iteration will have this transaction lock.
    
    Returns:
    
    Iterable containing references to all instances located in shared memory.
    
    Throws:
    
    ManagedClassError - Thrown if klass is not marked Managed, or is exactly ManagedObject.
    
    java.lang.IllegalArgumentException - The queryScope failed audit due to a bad node list.
    
    ResourceUnavailableException - Access to distributed services failed.
    
    See Also:
    
    Managed, QueryScope
  - hashCode
```
public static int hashCode(java.lang.Object o)
                    throws ManagedClassError
```
    Returns a hash code based on the underlying shared memory object.
    
    Parameters:
    
    o - Managed object to hash
    
    Returns:
    
    calculated hash code.
    
    Throws:
    
    ManagedClassError
  - equals
```
public static boolean equals(java.lang.Object o1,
                             java.lang.Object o2)
                      throws ManagedClassError
```
    Returns true if both references are proxies to the same shared memory object.
    
    Parameters:
    
    o1 - Managed object
    
    o2 - Managed object
    
    Returns:
    
    true if the two instances refer to the same Managed object.
    
    Throws:
    
    ManagedClassError - if o1 or o2 is not Managed.
  - isManaged
```
public static boolean isManaged(java.lang.Object o)
```
    Determines if the given object is an instance of a Managed class. Returns true only if the object, or a superclass, is marked @Managed.
    
    Parameters:
    
    o - Object to check.
    
    Returns:
    
    true if object is a Managed object.
  - isManagedClass
```
public static boolean isManagedClass(java.lang.Class<?> klass)
```
    Determines if the given class is Managed. Returns true only if the class, or a superclass, is marked @Managed.
    
    Parameters:
    
    klass - Class to check.
    
    Returns:
    
    true if class is Managed.
  - isPartitioned
```
public static boolean isPartitioned(java.lang.Class<?> klass)
```
    Determines if the given class is partitioned. Returns true if the @Managed class currently has a PartitionMapper installed.
    
    Parameters:
    
    klass - Class to check.
    
    Returns:
    
    true if class is partitioned.
    
    Throws:
    
    ManagedClassError - if klass not Managed.
  - getObjectReference
```
public static byte[] getObjectReference(java.lang.Object o)
```
    Return the object reference as a byte array. This may return a reference to the actual field, so the result should be treated as read-only.
    
    Parameters:
    
    o - Object to get reference from.
    
    Returns:
    
    byte array containing reference.
  - delete
```
public static void delete(java.lang.Object operand)
                   throws ManagedClassError
```
    Deletes a Managed object.
    
    Parameters:
    
    operand - Object to delete.
    
    Throws:
    
    ManagedClassError - if operand is not Managed.
  - objectToReference
```
public static java.lang.String objectToReference(java.lang.Object operand)
```
    Get a string version of an object reference
    If the object is invalid, an empty string is returned to the caller.
    
    Parameters:
    
    operand - Object to get reference for
    
    Returns:
    
    Stringified object reference
    
    Throws:
    
    ManagedClassError - if operand is not Managed.
  - referenceToObject
```
public static java.lang.Object referenceToObject(java.lang.String refStr)
```
    Convert a stringified object reference to an Object
    If the string reference is invalid an empty object is returned to the caller.
    
    Parameters:
    
    refStr - Object reference string
    
    Returns:
    
    Managed object associated with refStr
  - cardinality
```
public static int cardinality(java.lang.Class<?> klass)
                       throws ManagedClassError
```
    Returns the number of instances of the given class.
    This count does not require transaction locks on the extent or any of the individual objects in the extent.
    This means the number returned by cardinality() may change even as observed within a single transaction.
    
    Parameters:
    
    klass - extent class - instances of this type, and any subtypes that extend from this type, will be counted.
    
    Returns:
    
    Number of instances found.
    
    Throws:
    
    ManagedClassError - Thrown if klass is not marked Managed.
  - cardinality
```
public static int cardinality(java.lang.Class<?> klass,
                              QueryScope queryScope)
                       throws ManagedClassError,
                              java.lang.IllegalArgumentException,
                              ResourceUnavailableException
```
    Returns the number of instances of the given class.
    This count does not require transaction locks on the extent or any of the individual objects in the extent.
    This means the number returned by cardinality() may change even as observed within a single transaction.
    The queryScope parameter determines the scope of the search for object instances.
    
    Parameters:
    
    klass - extent class - instances of this type, and any subtypes that extend from this type, will be counted.
    
    queryScope - scope of cardinality lookup.
    
    Returns:
    
    Number of instances found.
    
    Throws:
    
    ManagedClassError - Thrown if klass is not marked Managed.
    
    java.lang.IllegalArgumentException - The queryScope failed audit due to a bad node list.
    
    ResourceUnavailableException - Access to distributed services failed.
    
    See Also:
    
    QueryScope
  - isEmpty
```
public static boolean isEmpty(java.lang.Object operand)
                       throws ManagedClassError
```
    Determines if the backing shared memory object has been deleted.
    
    Parameters:
    
    operand - Object to check.
    
    Returns:
    
    true if the operand has been deleted, false otherwise.
    
    Throws:
    
    ManagedClassError - if the operand object is not of a Managed class.
  - setDistributedQuery
```
public static void setDistributedQuery(com.kabira.platform.DistributedQuery distributedQuery)
```
    Internal method - do not use. Will be removed in a future release.
    
    Parameters:
    
    distributedQuery - Distributed query

Class ManagedObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManagedObject

Method Detail

extent

extent

extent

hashCode

equals

isManaged

isManagedClass

isPartitioned

getObjectReference

delete

objectToReference

referenceToObject

cardinality

cardinality

isEmpty

setDistributedQuery