org.objectweb.jorm.mapper.rdb.genclass
Interface RdbGenClassProp

All Superinterfaces:
GenClassProp
All Known Implementing Classes:
RdbGenClassMapping

public interface RdbGenClassProp
extends GenClassProp

It dscribes the setters for defining the properties that can be set when initialising a RdbGenClassMapping.

Author:
P. D?chamboux

Method Summary
 void defineJoinColumns(java.lang.String[] maincols, java.lang.String[] extcols)
          Defines the two sets of columns that are used to join the main table with the extension table.
 void setColocated(boolean colocated)
          Indicates if the table of the genclass is colocated
 void setColocatedMaster(boolean cm)
          Indicates if the table of the genclass is colocated
 void setPrefetchElementPCM(RdbPrefetchablePCM pcm)
          Specify the PClassMapping of the persistent class which must be prefetched
 void setReadOnly(boolean readonly)
          Indicates if the table must be only read.
 void setRefExtTableName(java.lang.String retn)
          Defines the table name property of a generic class instance mapped to a RDB for a table that owns extension fields of a reference element.
 void setTableName(java.lang.String tn)
          Defines the table name property of a generic class instance mapped to a RDB.
 void setTypeConverter(RdbAdapter adapter)
          Defines the type converter property of a generic class instance mapped to a RDB.
 
Methods inherited from interface org.objectweb.jorm.genclass.api.GenClassProp
setElemDesc, setIdentifierDesc, setIndexDesc, setPType
 

Method Detail

setTableName

public void setTableName(java.lang.String tn)
Defines the table name property of a generic class instance mapped to a RDB.

Parameters:
tn - The table name

setRefExtTableName

public void setRefExtTableName(java.lang.String retn)
Defines the table name property of a generic class instance mapped to a RDB for a table that owns extension fields of a reference element.

Parameters:
retn - The table name of the extension fields

defineJoinColumns

public void defineJoinColumns(java.lang.String[] maincols,
                              java.lang.String[] extcols)
Defines the two sets of columns that are used to join the main table with the extension table.

Parameters:
maincols - Names of columns within the main table.
extcols - Names of columns within the extension table.

setTypeConverter

public void setTypeConverter(RdbAdapter adapter)
Defines the type converter property of a generic class instance mapped to a RDB.

Parameters:
adapter - The associated type.

setColocated

public void setColocated(boolean colocated)
Indicates if the table of the genclass is colocated


setColocatedMaster

public void setColocatedMaster(boolean cm)
Indicates if the table of the genclass is colocated


setReadOnly

public void setReadOnly(boolean readonly)
Indicates if the table must be only read.

Parameters:
readonly -

setPrefetchElementPCM

public void setPrefetchElementPCM(RdbPrefetchablePCM pcm)
Specify the PClassMapping of the persistent class which must be prefetched