org.exolab.castor.mapping.AccessMode Class Reference

List of all members.

Public Member Functions
String	toString ()
Static Public Member Functions
static AccessMode	getAccessMode (String accessMode)
Static Public Attributes
static final AccessMode	ReadOnly = new AccessMode( "read-only" )
static final AccessMode	Shared = new AccessMode( "shared" )
static final AccessMode	Exclusive = new AccessMode( "exclusive" )
static final AccessMode	DbLocked = new AccessMode( "db-locked" )

---

Detailed Description

The access mode for a class. This object is used by class descriptors to specify the access mode for a class.

In persistent storage each class is defined as having one of three access modes:

• Read only
• Shared (aka optimistic locking)
• Exclusive (aka pessimistic locking)
• DbLocked (database lock)

Transactions typically access objects based on the specified access mode. A transaction may be requested to access any object as read only or exclusive, but may not access exclusive objects as shared.

Author:

Assaf Arkin

Version:

Revision:

1.1.1.1

Date:

2003/03/03 07:08:26

---

Member Function Documentation

static AccessMode org.exolab.castor.mapping.AccessMode.getAccessMode

(

String

accessMode

)

[static]

Returns the access mode from the name. If accessMode is null, return the default access mode (Shared). Otherwise returns the named access mode.

Parameters:

accessMode

The access mode name

Returns:

The access mode

References org.exolab.castor.mapping.AccessMode.DbLocked, org.exolab.castor.mapping.AccessMode.Exclusive, org.exolab.castor.mapping.AccessMode.ReadOnly, and org.exolab.castor.mapping.AccessMode.Shared.

String org.exolab.castor.mapping.AccessMode.toString

(

)

---

Member Data Documentation

final AccessMode org.exolab.castor.mapping.AccessMode.DbLocked = new AccessMode( "db-locked" ) [static]

DbLocked access. Objects can be access by a single transaction at any given time, and a lock is acquired in the database.

Referenced by org.exolab.castor.mapping.AccessMode.getAccessMode().

final AccessMode org.exolab.castor.mapping.AccessMode.Exclusive = new AccessMode( "exclusive" ) [static]

Exclusive access. Objects can be access by a single transaction at any given time. Equivalent to pessimistic locking.

Referenced by org.exolab.castor.mapping.AccessMode.getAccessMode().

final AccessMode org.exolab.castor.mapping.AccessMode.ReadOnly = new AccessMode( "read-only" ) [static]

Read only access. Objects can be read but are not made persistent and changes to objects are not reflected in persistent storage.

Referenced by org.exolab.castor.mapping.AccessMode.getAccessMode().

final AccessMode org.exolab.castor.mapping.AccessMode.Shared = new AccessMode( "shared" ) [static]

Shared access. Objects can be read by multiple concurrent transactions. Equivalent to optimistic locking.

Referenced by org.exolab.castor.mapping.AccessMode.getAccessMode().

---

The documentation for this class was generated from the following file:

• AccessMode.java