|
| |
|
| java.lang.Object
 org.objectweb.speedo.metadata.SpeedoElement
org.objectweb.speedo.metadata.SpeedoClass
| SpeedoClass | | public class SpeedoClass extends SpeedoElement (Code) | | Describes a persistence capable class.
author:
S.Chassande-Barrioz |
| ALREADY_ENHANCED | | final public static byte ALREADY_ENHANCED(Code) | | The class has been previously enhanced and no additional operation is
required.
|
| ENHANCEMENT_FAILED | | final public static byte ENHANCEMENT_FAILED(Code) | | The enhancement of the class has failed.
|
| ENHANCEMENT_REQUIRED | | final public static byte ENHANCEMENT_REQUIRED(Code) | | The enhancement is required.
|
| NON_PUBLIC_NO_ARG_CONSTRUCTOR | | final public static byte NON_PUBLIC_NO_ARG_CONSTRUCTOR(Code) | | The persistent class has no-arg constructor but it is not public
|
| NO_NO_ARG_CONSTRUCTOR | | final public static byte NO_NO_ARG_CONSTRUCTOR(Code) | | The persistent class has no no-arg constructor.
|
| PUBLIC_NO_ARG_CONSTRUCTOR | | final public static byte PUBLIC_NO_ARG_CONSTRUCTOR(Code) | | The persistent class has a public no-arg constructor.
|
| callBacks | | public HashMap callBacks(Code) | | Register some callback methods and their associated application method to
which the callback is mapped.
It contains an Integer key identifying a particular callback, which is associated
with an ArrayList of methods to be called when this callback is fired.
Such methods are specified through a metaobject specifying the callback:
See Also: SpeedoCallback
See Also: HomeItf.PRE_NEW |
| fetchGroups | | public Map fetchGroups(Code) | | Description of fetchgroups defined for this class. The HashMap key is the
field name.
|
| fields | | public Map fields(Code) | | Description of persistent capable fields of this class. The HashMap key
is the field name.
|
| inheritance | | public SpeedoInheritance inheritance(Code) | | Defines the inheritance strategy if this class inherits from a persistent
class.
|
| isAbstract | | public boolean isAbstract(Code) | | Indicates if the class is abstract.
|
| isDetachable | | public boolean isDetachable(Code) | | Attribute detachable.
|
| isInstanceCallbacks | | public boolean isInstanceCallbacks(Code) | | Indicates if the class implements InstanceCallbacks
|
| isSerializable | | public boolean isSerializable(Code) | | Indicates if the class implements Serailizable
|
| joinToExtTables | | public SpeedoJoin[] joinToExtTables(Code) | | Is the join to reach external tables. It can be null if there is no
external table.
|
| jormclass | | public Class jormclass(Code) | | JORM meta object corresponding to this Speedo meta object.
|
| moPackage | | public SpeedoPackage moPackage(Code) | | Description of the package which contains this class.
|
| name2query | | public Map name2query(Code) | | Contains the predefined query key = a query name value = the
SpeedoPredefinedQuery instance
See Also: SpeedoPredefinedQuery |
| nameForQuery | | public String nameForQuery(Code) | | Class name for queries.
|
| versionField | | public SpeedoField versionField(Code) | | Defines the field used for database optimitic locking policy.
|
| add | | public void add(Object field)(Code) | | Adds a SpeedoField to the class. Precondition: this field doesn't exist
in the jdoFields HashMap.
Parameters:
field - field to add. |
| add | | public void add(Object field, boolean failsOnError, Logger logger) throws SpeedoException(Code) | | Adds a SpeedoField to the class.
Parameters:
field - field to add.
Parameters:
failsOnError - if an error must be thrown or creates a warning.
Parameters:
logger - logger for writting warn message if necessary.
exception:
SpeedoException - if the field was already defined into the class. |
| addFetchGroup | | public void addFetchGroup(Object fetchGroup)(Code) | | Adds a SpeedoFetchGroup to the class. Precondition: this fetchgroup
doesn't exist in the jdoFtechGroups HashMap.
Parameters:
fetchGroup - the fetchgroup to add. |
| addFetchGroup | | public void addFetchGroup(Object fetchGroup, boolean failsOnError, Logger logger) throws SpeedoException(Code) | | Adds a SpeedoFetchgroup to the class.
Parameters:
fetchGroup - the fetchgroup to add.
Parameters:
failsOnError - if an error must be thrown or creates a warning.
Parameters:
logger - logger for writting warn message if necessary.
exception:
SpeedoException - if the field was already defined into the class. |
| computeFieldNumbers | | public int computeFieldNumbers()(Code) | | Computes the field numbers for the fields of this class.
the number of fields of this class (including inherited fields). |
| enhancementFailed | | public boolean enhancementFailed()(Code) | | |
| generateObjectId | | public boolean generateObjectId()(Code) | | |
| getColumn | | public SpeedoColumn getColumn(String colname, boolean mainonly)(Code) | | Look for a column with a given name defined into the given SpeedoClass.
Parameters:
colname - The name of the column.
Parameters:
mainonly - Speficy if we must look only for main table columns. The column found or null if none. |
| getFQName | | public String getFQName()(Code) | | the fully qualified name of the class (include the package name)the package separator is a dot |
| getField | | public SpeedoField getField(String fieldName)(Code) | | Finds a field from its name. The fields can belong this class or an
ancestor of this class.
Parameters:
fieldName - is the name of a persistent field. the name can be fullyqualified (ie the field name is prefixed by the class name,the separator is a dot or #) the SpeedoField instance if it has been found., otherwise null |
| getIdentityType | | public byte getIdentityType()(Code) | | |
| getPkFieldCount | | public int getPkFieldCount()(Code) | | |
| getTableIndexes | | public List getTableIndexes()(Code) | | |
| getUniquePKField | | public SpeedoField getUniquePKField() throws SpeedoException(Code) | | Find in the class or in its parent, the unique persistent field marked as
primary key.
the unique pk fields if it exists one, null otherwise.
throws:
SpeedoException - if there are several persistent fields marked as primary key. |
| isAlreadyEnhanced | | public boolean isAlreadyEnhanced()(Code) | | |
| requireEnhancement | | public boolean requireEnhancement()(Code) | | |
| setAlreadyEnhanced | | public void setAlreadyEnhanced(boolean v)(Code) | | |
| setDatastoreIdSequenceName | | public void setDatastoreIdSequenceName(String sequenceName)(Code) | | |
| setIdentityType | | public void setIdentityType(byte identityType)(Code) | | |
| setRequireEnhancement | | public void setRequireEnhancement(boolean v)(Code) | | |
| toString | | public String toString()(Code) | | Transforms a SpeedoClass into a String.
the Sting corresponding to the SpeedoClass. |
|
|
|