org.batoo.jpa.jdbc.mapping

Interface Mapping<Z,X,Y>

Type Parameters:

Z - the source type

X - the destination type

Y - the attribute type

All Known Subinterfaces:

AssociationMapping<Z,X,Y>, BasicMapping<Z,X>, ElementCollectionMapping<Z,C,E>, EmbeddedMapping<Z,X>, JoinedMapping<Z,X,Y>, ParentMapping<Z,X>, PluralMapping<Z,C,E>, PluralMappingEx<Z,C,E>, SingularAssociationMapping<Z,X>, SingularMapping<Z,X>, SingularMappingEx<Z,X>

All Known Implementing Classes:

AbstractMapping, AbstractParentMapping, AssociationMappingImpl, BasicMappingImpl, ElementCollectionMappingImpl, ElementMappingImpl, EmbeddedMappingImpl, EntityMapping, PluralAssociationMappingImpl, SingularAssociationMappingImpl

public interface Mapping<Z,X,Y>

The interface for mappings.

Since:

2.0.1

Author:

hceylan

Method Summary

Methods

Modifier and Type	Method and Description
X	get(Object instance) Returns the mapping value of instance.
Member	getJavaMember() Returns the java member of the mapping.
Class<X>	getJavaType() Returns the javaType of the mapping.
AbstractLocator	getLocator() Returns the locator of the mapping.
String	getName() Returns the name of the AbstractMapping.
ParentMapping<?,Z>	getParent() Returns the parent of the mapping.
String	getPath() Returns the path of the mapping.
RootMapping<?>	getRoot() Returns the root of the mapping.
boolean	isCollection() Returns if the mapping is a collection mapping.
void	set(Object instance, Object value) Sets the mapping value of instance.

Method Detail

get

X get(Object instance)

Returns the mapping value of instance.

Parameters:

instance - the instance of which the value to be returned

Returns:

the mapping value of instance

Since:

2.0.0

getJavaMember

Member getJavaMember()

Returns the java member of the mapping.

Returns:

the java member of the mapping

Since:

2.0.1

getJavaType

Class<X> getJavaType()

Returns the javaType of the mapping.

Returns:

the javaType of the mapping

Since:

2.0.0

getLocator

AbstractLocator getLocator()

Returns the locator of the mapping.

Returns:

the locator of the mapping

Since:

2.0.1

getName

String getName()

Returns the name of the AbstractMapping.

Returns:

the name of the AbstractMapping

Since:

2.0.0

getParent

ParentMapping<?,Z> getParent()

Returns the parent of the mapping.

Returns:

the parent of the mapping

Since:

2.0.0

getPath

String getPath()

Returns the path of the mapping.

Returns:

the path of the mapping

Since:

2.0.0

getRoot

RootMapping<?> getRoot()

Returns the root of the mapping.

Returns:

the root of the mapping

Since:

2.0.0

isCollection

boolean isCollection()

Returns if the mapping is a collection mapping.

Returns:

true if the mapping is a collection mapping, false otherwise

Since:

2.0.1

set

void set(Object instance,
       Object value)

Sets the mapping value of instance.

Parameters:

instance - the instance of which the value to set

value - the value to set

Since:

2.0.0