Package org.hibernate.type

Class MapType

java.lang.Object

org.hibernate.type.AbstractType

org.hibernate.type.CollectionType

org.hibernate.type.MapType

All Implemented Interfaces:

Serializable, AssociationType, Type

Direct Known Subclasses:

OrderedMapType, SortedMapType

public class MapType
extends CollectionType

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hibernate.type.CollectionType

UNFETCHED_COLLECTION

Fields inherited from class org.hibernate.type.AbstractType

LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE

Constructor Summary

Constructors

Constructor	Description
MapType(String role, String propertyRef)

Method Summary

Modifier and Type	Method	Description
CollectionClassification	getCollectionClassification()
Iterator<?>	getElementsIterator(Object collection)	Get an iterator over the element set of the collection, which may not yet be wrapped
Class<?>	getReturnedClass()	The class handled by this type.
Object	indexOf(Object collection, Object element)
Object	instantiate(int anticipatedSize)	Instantiate an empty instance of the "underlying" collection (not a wrapper), but with the given anticipated size (i.e.
PersistentCollection<?>	instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)	Instantiate an uninitialized collection wrapper or holder.
Object	replaceElements(Object original, Object target, Object owner, Map copyCache, SharedSessionContractImplementor session)	Replace the elements of a collection with the elements of another collection.
PersistentCollection<?>	wrap(SharedSessionContractImplementor session, Object collection)	Wrap the naked collection instance in a wrapper, or instantiate a holder.

Methods inherited from class org.hibernate.type.CollectionType

assemble, compare, compare, contains, deepCopy, disassemble, disassemble, getAssociatedEntityName, getAssociatedJoinable, getCollection, getColumnSpan, getElementsIterator, getElementType, getForeignKeyDirection, getHashCode, getIdOfOwnerOrNull, getKeyOfOwner, getLHSPropertyName, getName, getRHSUniqueKeyPropertyName, getRole, getSqlTypeCodes, hasHolder, initializeImmediately, instantiateResult, isAlwaysDirtyChecked, isArrayType, isAssociationType, isCollectionType, isDirty, isDirty, isEqual, isModified, isMutable, nullSafeSet, nullSafeSet, renderLoggableString, replace, toColumnNullness, toLoggableString, toString, useLHSPrimaryKey

Methods inherited from class org.hibernate.type.AbstractType

beforeAssemble, getHashCode, isAnyType, isComponentType, isEntityType, isEqual, isSame, replace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.type.Type

beforeAssemble, getHashCode, isAnyType, isComponentType, isEntityType, isEqual, isSame, replace

Constructor Detail

MapType

public MapType(String role,
               String propertyRef)

Method Detail

getCollectionClassification

public CollectionClassification getCollectionClassification()

Specified by:

getCollectionClassification in class CollectionType

instantiate

public PersistentCollection<?> instantiate(SharedSessionContractImplementor session,
                                           CollectionPersister persister,
                                           Object key)

Description copied from class: CollectionType

Instantiate an uninitialized collection wrapper or holder. Callers MUST add the holder to the persistence context!

Specified by:

instantiate in class CollectionType

Parameters:

session - The session from which the request is originating.

persister - The underlying collection persister (metadata)

key - The owner key.

Returns:

The instantiated collection.

getReturnedClass

public Class<?> getReturnedClass()

Description copied from interface: Type

The class handled by this type.

Returns:

The java type class handled by this type.

getElementsIterator

public Iterator<?> getElementsIterator(Object collection)

Description copied from class: CollectionType

Get an iterator over the element set of the collection, which may not yet be wrapped

Overrides:

getElementsIterator in class CollectionType

Parameters:

collection - The collection to be iterated

Returns:

The element iterator

wrap

public PersistentCollection<?> wrap(SharedSessionContractImplementor session,
                                    Object collection)

Description copied from class: CollectionType

Wrap the naked collection instance in a wrapper, or instantiate a holder. Callers MUST add the holder to the persistence context!

Specified by:

wrap in class CollectionType

Parameters:

session - The session from which the request is originating.

collection - The bare collection to be wrapped.

Returns:

The wrapped collection.

instantiate

public Object instantiate(int anticipatedSize)

Description copied from class: CollectionType

Instantiate an empty instance of the "underlying" collection (not a wrapper), but with the given anticipated size (i.e. accounting for initial capacity and perhaps load factor).

Specified by:

instantiate in class CollectionType

Parameters:

anticipatedSize - The anticipated size of the instantiated collection after we are done populating it.

Returns:

A newly instantiated collection to be wrapped.

replaceElements

public Object replaceElements(Object original,
                              Object target,
                              Object owner,
                              Map copyCache,
                              SharedSessionContractImplementor session)
                       throws HibernateException

Description copied from class: CollectionType

Replace the elements of a collection with the elements of another collection.

Overrides:

replaceElements in class CollectionType

Parameters:

original - The 'source' of the replacement elements (where we copy from)

target - The target of the replacement elements (where we copy to)

owner - The owner of the collection being merged

copyCache - The map of elements already replaced.

session - The session from which the merge event originated.

Returns:

The merged collection.

Throws:

HibernateException

indexOf

public Object indexOf(Object collection,
                      Object element)

Overrides:

indexOf in class CollectionType