FileDocCategorySizeDatePackage
MappingFieldElement.javaAPI DocGlassfish v2 API5828Fri May 04 22:34:44 BST 2007com.sun.jdo.api.persistence.model.mapping

MappingFieldElement

public interface MappingFieldElement implements MappingMemberElement
author
raccah
version
%I%

Fields Summary
public static final int
GROUP_DEFAULT
Constant representing the jdo default fetch group. This is what used to be mandatory for SynerJ.
public static final int
GROUP_NONE
Constant representing no fetch group.
public static final int
GROUP_INDEPENDENT
Constant representing an independent fetch group. All independent fetch groups must have a value less than or equal to this constant.
Constructors Summary
Methods Summary
public voidaddColumn(org.netbeans.modules.dbschema.DBMemberElement column)
Adds a column to the list of columns mapped by this mapping field.

param
column column element to be added to the mapping
exception
ModelException if impossible

public java.util.ArrayListgetColumns()
Returns the list of column names to which this mapping field is mapped.

return
the names of the columns mapped by this mapping field

public intgetFetchGroup()
Get the fetch group of this field element.

return
the fetch group, one of {@link #GROUP_DEFAULT}, {@link #GROUP_NONE}, or anything less than or equal to {@link #GROUP_INDEPENDENT}

public booleanisInConcurrencyCheck()
Determines whether this field element is in a concurrency check or not.

return
true if the field is in a concurrency check, false otherwise

public booleanisReadOnly()
Determines whether this field element is read only or not.

return
true if the field is read only, false otherwise

public booleanisVersion()
Determines whether this field element is a version field or not.

return
true if the field is a version field, false otherwise

public voidremoveColumn(java.lang.String columnName)
Removes a column from the list of columns mapped by this mapping field.

param
columnName the relative name of the column to be removed from the mapping
exception
ModelException if impossible

public voidsetFetchGroup(int group)
Set the fetch group of this field element.

param
group - an integer indicating the fetch group, one of: {@link #GROUP_DEFAULT}, {@link #GROUP_NONE}, or anything less than or equal to {@link #GROUP_INDEPENDENT}
exception
ModelException if impossible

public voidsetInConcurrencyCheck(boolean flag)
Set whether this field element is in a concurrency check or not.

param
flag - if true, the field element is marked as being in a concurrency check; otherwise, it is not
exception
ModelException if impossible

public voidsetReadOnly(boolean flag)
Set whether this field element is read only or not.

param
flag - if true, the field element is marked as read only; otherwise, it is not
exception
ModelException if impossible

public voidsetVersion(boolean flag)
Set whether this field element is a version field or not.

param
flag - if true, the field element is marked as a version field; otherwise, it is not
exception
ModelException if impossible