Top Description Fields Methods
org.hibernate.boot.spi

public Interface MappingDefaults

Known Direct Implementers
org.hibernate.boot.internal.MetadataBuilderImpl.MappingDefaultsImpl, org.hibernate.boot.model.source.internal.OverriddenMappingDefaults
Imports
org.hibernate.cache.spi.access.AccessType, org.hibernate.metamodel.CollectionClassification
Values to use as defaults in the absence of certain mapping information.

Implementation Specification

Designed with stacking in mind, such that the defaults can be overridden at various levels using simple wrapping and delegation. The "global" level is configuration settings.

Authors
Steve Ebersole, Gail Badner
Since
5.0

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT_CASCADE_NAME

public static final String
DEFAULT_DISCRIMINATOR_COLUMN_NAME

public static final String
DEFAULT_IDENTIFIER_COLUMN_NAME

public static final String
DEFAULT_PROPERTY_ACCESS_NAME

public static final String
DEFAULT_TENANT_IDENTIFIER_COLUMN_NAME

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

The implicit association laziness
areCollectionsImplicitlyLazy()

Identifies whether plural attributes are lazy by default if not specified in the mapping.

public boolean

Returns:

The implicit association laziness
areEntitiesImplicitlyLazy()

Identifies whether singular associations (many-to-one, one-to-one) are lazy by default if not specified in the mapping.

public AccessType
getImplicitCacheAccessType()

The cache access type to use if none is specified

public String

Returns:

The implicit cascade style
getImplicitCascadeStyleName()

Identifies the cascade style to apply to associations if none specified in the mapping.

public String

Returns:

The implicit catalog name; may be null
getImplicitCatalogName()

Identifies the database catalog name to use if none specified in the mapping.

public String

Returns:

The implicit discriminator column name
getImplicitDiscriminatorColumnName()

Identifies the column name to use for the discriminator column if none specified in the mapping.

public String

Returns:

The implicit identifier column name
getImplicitIdColumnName()

Identifies the column name to use for the identifier column if none specified in the mapping.

public CollectionClassification
getImplicitListClassification()

Collection semantics to be applied to java.util.List attributes with no explicit configuration

public String

Returns:

The implicit package name.
getImplicitPackageName()

Identifies the package name to use if none specified in the mapping.

public String

Returns:

The implicit property accessor name
getImplicitPropertyAccessorName()

Identifies the default org.hibernate.property.access.spi.PropertyAccessStrategy name to use if none specified in the mapping.

public String

Returns:

The implicit schema name; may be null
getImplicitSchemaName()

Identifies the database schema name to use if none specified in the mapping.

public String

Returns:

The implicit tenant identifier column name
getImplicitTenantIdColumnName()

Identifies the column name to use for the tenant identifier column if none is specified in the mapping.

public boolean

Returns:

true if auto-importing is enabled; false otherwise.
isAutoImportEnabled()

Is auto-importing of entity (short) names enabled?

public boolean

Returns:

true/false
shouldImplicitlyQuoteIdentifiers()

Should all database identifiers encountered in this context be implicitly quoted?

Field Detail

DEFAULT_CASCADE_NAMEback to summary
public static final String DEFAULT_CASCADE_NAME
DEFAULT_DISCRIMINATOR_COLUMN_NAMEback to summary
public static final String DEFAULT_DISCRIMINATOR_COLUMN_NAME
DEFAULT_IDENTIFIER_COLUMN_NAMEback to summary
public static final String DEFAULT_IDENTIFIER_COLUMN_NAME
DEFAULT_PROPERTY_ACCESS_NAMEback to summary
public static final String DEFAULT_PROPERTY_ACCESS_NAME
DEFAULT_TENANT_IDENTIFIER_COLUMN_NAMEback to summary
public static final String DEFAULT_TENANT_IDENTIFIER_COLUMN_NAME

Method Detail

areCollectionsImplicitlyLazyback to summary
public boolean areCollectionsImplicitlyLazy()

Identifies whether plural attributes are lazy by default if not specified in the mapping.

Returns:boolean

The implicit association laziness

areEntitiesImplicitlyLazyback to summary
public boolean areEntitiesImplicitlyLazy()

Identifies whether singular associations (many-to-one, one-to-one) are lazy by default if not specified in the mapping.

Returns:boolean

The implicit association laziness

getImplicitCacheAccessTypeback to summary
public AccessType getImplicitCacheAccessType()

The cache access type to use if none is specified

See Also
org.hibernate.cfg.AvailableSettings#DEFAULT_CACHE_CONCURRENCY_STRATEGY
getImplicitCascadeStyleNameback to summary
public String getImplicitCascadeStyleName()

Identifies the cascade style to apply to associations if none specified in the mapping.

Returns:String

The implicit cascade style

getImplicitCatalogNameback to summary
public String getImplicitCatalogName()

Identifies the database catalog name to use if none specified in the mapping.

Returns:String

The implicit catalog name; may be null

getImplicitDiscriminatorColumnNameback to summary
public String getImplicitDiscriminatorColumnName()

Identifies the column name to use for the discriminator column if none specified in the mapping.

Returns:String

The implicit discriminator column name

getImplicitIdColumnNameback to summary
public String getImplicitIdColumnName()

Identifies the column name to use for the identifier column if none specified in the mapping.

Returns:String

The implicit identifier column name

getImplicitListClassificationback to summary
public CollectionClassification getImplicitListClassification()

Collection semantics to be applied to java.util.List attributes with no explicit configuration

See Also
org.hibernate.cfg.AvailableSettings#DEFAULT_LIST_SEMANTICS
getImplicitPackageNameback to summary
public String getImplicitPackageName()

Identifies the package name to use if none specified in the mapping. Really only pertinent for hbm.xml mappings.

Returns:String

The implicit package name.

getImplicitPropertyAccessorNameback to summary
public String getImplicitPropertyAccessorName()

Identifies the default org.hibernate.property.access.spi.PropertyAccessStrategy name to use if none specified in the mapping.

Returns:String

The implicit property accessor name

See Also
org.hibernate.property.access.spi.PropertyAccessStrategy
getImplicitSchemaNameback to summary
public String getImplicitSchemaName()

Identifies the database schema name to use if none specified in the mapping.

Returns:String

The implicit schema name; may be null

getImplicitTenantIdColumnNameback to summary
public String getImplicitTenantIdColumnName()

Identifies the column name to use for the tenant identifier column if none is specified in the mapping.

Returns:String

The implicit tenant identifier column name

isAutoImportEnabledback to summary
public boolean isAutoImportEnabled()

Is auto-importing of entity (short) names enabled?

Returns:boolean

true if auto-importing is enabled; false otherwise.

shouldImplicitlyQuoteIdentifiersback to summary
public boolean shouldImplicitlyQuoteIdentifiers()

Should all database identifiers encountered in this context be implicitly quoted? true indicates that all identifier encountered within this context should be quoted. false indicates indicates that identifiers within this context are only quoted if explicitly quoted.

Returns:boolean

true/false