org.eclipse.jpt.jpa.core.context
Interface OptionalMapping

All Superinterfaces:

AttributeMapping, org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

BasicMapping, EclipseLinkBasicMapping, EclipseLinkOneToOneMapping, EclipseLinkOneToOneMapping2_0, JavaBasicMapping, JavaManyToOneMapping, JavaManyToOneMapping2_0, JavaOneToOneMapping, JavaOneToOneMapping2_0, JavaSingleRelationshipMapping, JavaSingleRelationshipMapping2_0, ManyToOneMapping, ManyToOneMapping2_0, OneToOneMapping, OneToOneMapping2_0, OrmBasicMapping, OrmManyToOneMapping, OrmManyToOneMapping2_0, OrmOneToOneMapping, OrmOneToOneMapping2_0, OrmSingleRelationshipMapping, OrmSingleRelationshipMapping2_0, SingleRelationshipMapping, SingleRelationshipMapping2_0

public interface OptionalMapping
extends AttributeMapping

JPA attribute mapping that is optional (e.g. basic, single relationship). From the JPA spec:

 Whether the value of the field or property may be null. This is a hint 
 and is disregarded for primitive types; it may be used in schema generation.
 

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.0

Version:

2.2

Field Summary

static boolean	DEFAULT_OPTIONAL
static java.lang.String	DEFAULT_OPTIONAL_PROPERTY
static java.lang.String	SPECIFIED_OPTIONAL_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.context.AttributeMapping

DEFAULT_PROPERTY

Method Summary

java.lang.Boolean	getSpecifiedOptional()
boolean	isDefaultOptional()
boolean	isOptional()
void	setSpecifiedOptional(java.lang.Boolean newSpecifiedOptional)

Methods inherited from interface org.eclipse.jpt.jpa.core.context.AttributeMapping

allMappingNames, allOverridableAssociationMappingNames, allOverridableAttributeMappingNames, getKey, getName, getPersistentAttribute, getPrimaryKeyColumnName, getTypeMapping, isDefault, isOverridableAssociationMapping, isOverridableAttributeMapping, isOwnedBy, isRelationshipOwner, resolveAttributeMapping, resolveOverriddenColumn, resolveOverriddenRelationship, validatesAgainstDatabase

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode

getJpaProject, getParent, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.IResourcePart

getResource

Field Detail

DEFAULT_OPTIONAL_PROPERTY

static final java.lang.String DEFAULT_OPTIONAL_PROPERTY

See Also:

Constant Field Values

DEFAULT_OPTIONAL

static final boolean DEFAULT_OPTIONAL

See Also:

Constant Field Values

SPECIFIED_OPTIONAL_PROPERTY

static final java.lang.String SPECIFIED_OPTIONAL_PROPERTY

See Also:

Constant Field Values

Method Detail

isOptional

boolean isOptional()

isDefaultOptional

boolean isDefaultOptional()

getSpecifiedOptional

java.lang.Boolean getSpecifiedOptional()

setSpecifiedOptional

void setSpecifiedOptional(java.lang.Boolean newSpecifiedOptional)