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

All Superinterfaces:

AttributeMapping, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

BasicMapping, EclipseLinkBasicMapping, EclipseLinkManyToOneMapping, EclipseLinkManyToOneMapping2_0, EclipseLinkOneToOneMapping, EclipseLinkOneToOneMapping2_0, JavaBasicMapping, JavaManyToOneMapping, JavaOneToOneMapping, JavaSingleRelationshipMapping, JavaSingleRelationshipMapping2_0, ManyToOneMapping, ManyToOneMapping2_0, OneToOneMapping, OneToOneMapping2_0, OrmBasicMapping, OrmManyToOneMapping, OrmOneToOneMapping, 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.AttributeMapping

AttributeMapping.AllMappingNamesTransformer, AttributeMapping.AllOverridableAssociationMappingNamesTransformer, AttributeMapping.AllOverridableAttributeMappingNamesTransformer, AttributeMapping.GeneratorsTransformer, AttributeMapping.IsNotTransient, AttributeMapping.IsOverridableAssociationMapping, AttributeMapping.KeyEquals, AttributeMapping.NameTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static boolean	DEFAULT_OPTIONAL
static String	DEFAULT_OPTIONAL_PROPERTY
static String	SPECIFIED_OPTIONAL_PROPERTY

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

ALL_MAPPING_NAMES_TRANSFORMER, ALL_OVERRIDABLE_ASSOCIATION_MAPPING_NAMES_TRANSFORMER, ALL_OVERRIDABLE_ATTRIBUTE_MAPPING_NAMES_TRANSFORMER, DEFAULT_PROPERTY, GENERATORS_TRANSFORMER, IS_NOT_TRANSIENT, IS_OVERRIDABLE_ASSOCIATION_MAPPING, NAME_TRANSFORMER

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

Boolean	getSpecifiedOptional()
boolean	isDefaultOptional()
boolean	isOptional()
void	setSpecifiedOptional(Boolean newSpecifiedOptional)

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

getAllMappingNames, getAllOverridableAssociationMappingNames, getAllOverridableAttributeMappingNames, getGenerators, getKey, getName, getPersistentAttribute, getPrimaryKeyColumnName, getTypeMapping, isDefault, isOverridableAssociationMapping, isOverridableAttributeMapping, isOwnedBy, isRelationshipOwner, resolveAttributeMapping, resolveOverriddenColumn, resolveOverriddenRelationship, validatesAgainstDatabase

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

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

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

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

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

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

getAdapter

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

getResourceType

Field Detail

DEFAULT_OPTIONAL_PROPERTY

static final 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 String SPECIFIED_OPTIONAL_PROPERTY

See Also:

Constant Field Values

Method Detail

isOptional

boolean isOptional()

isDefaultOptional

boolean isDefaultOptional()

getSpecifiedOptional

Boolean getSpecifiedOptional()

setSpecifiedOptional

void setSpecifiedOptional(Boolean newSpecifiedOptional)