MappingFactory (Grace Data

org.grails.datastore.mapping.model.MappingFactory

@SuppressWarnings({ "rawtypes", "unchecked" })
public abstract class MappingFactory<R extends Entity, T extends Property>
extends Object

An abstract factory for creating persistent property instances.

Subclasses should implement the createMappedForm method in order to provide a mechanisms for representing the property in a form appropriate for mapping to the underlying datastore. Example:

  
      class RelationalPropertyFactory<Column> extends PropertyFactory {
            public Column createMappedForm(PersistentProperty mpp) {
                return new Column(mpp)
            }
      }

Authors:: Graeme Rocher

Since:: 1.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`IDENTITY_PROPERTY`
`static Set<String>`	`SIMPLE_TYPES`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected boolean`	`allowArbitraryCustomTypes()`
	`public static String`	`associationtoString(String desc, Association a)`
	`public Basic`	`createBasicCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property, Class collectionType)` Creates a Basic collection type
	`public Basic`	`createBasicCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property)`
	`public Custom<T>`	`createCustom(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)` Creates a custom prpoerty type
	`public IdentityMapping`	`createDefaultIdentityMapping(ClassMapping classMapping)`
	`protected IdentityMapping`	`createDefaultIdentityMapping(ClassMapping classMapping, T property)`
	`public Embedded`	`createEmbedded(PersistentEntity entity, MappingContext context, PropertyDescriptor property)` Creates an Embedded type used to model an embedded association (composition)
	`public EmbeddedCollection`	`createEmbeddedCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property)` Creates an EmbeddedCollection type used to model an embedded collection association (composition).
	`public Identity<T>`	`createIdentity(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)` Creates an identifier property
	`public IdentityMapping`	`createIdentityMapping(ClassMapping classMapping)`
	`public ManyToMany`	`createManyToMany(PersistentEntity entity, MappingContext context, PropertyDescriptor property)` Creates a ManyToMany type used to model a many-to-many association between entities
	`public ToOne`	`createManyToOne(PersistentEntity entity, MappingContext context, PropertyDescriptor property)` Creates a many-to-one association type used for a mapping a many-to-one association between entities
	`public abstract R`	`createMappedForm(PersistentEntity entity)` Creates the mapped form of a persistent entity
	`public abstract T`	`createMappedForm(PersistentProperty mpp)` Creates the mapped form of a PersistentProperty instance
	`public OneToMany`	`createOneToMany(PersistentEntity entity, MappingContext context, PropertyDescriptor property)` Creates a OneToMany type used to model a one-to-many association between entities
	`public ToOne`	`createOneToOne(PersistentEntity entity, MappingContext context, PropertyDescriptor property)` Creates a one-to-one association type used for mapping a one-to-one association between entities
	`public PropertyDescriptor`	`createPropertyDescriptor(Class declaringClass, MetaProperty property)` Creates a PropertyDescriptor from a MetaBeanProperty
	`protected PropertyMapping<T>`	`createPropertyMapping(PersistentProperty<T> property, PersistentEntity owner)`
	`public Simple<T>`	`createSimple(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)` Creates a simple property type used for mapping basic types such as String, long, integer etc.
	`public TenantId<T>`	`createTenantId(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)` Creates the tenant identifier property
	`protected CustomTypeMarshaller`	`findCustomType(MappingContext context, Class<?> propertyType)`
	`public ClassMapping`	`getClassMapping()`
	`public ClassMapping`	`getClassMapping()`
	`public ClassMapping`	`getClassMapping()`
	`public ClassMapping`	`getClassMapping()`
	`public ValueGenerator`	`getGenerator()`
	`public ValueGenerator`	`getGenerator()`
	`public String[]`	`getIdentifierName()`
	`public String[]`	`getIdentifierName()`
	`public T`	`getMappedForm()`
	`public T`	`getMappedForm()`
	`public Property`	`getMappedForm()`
	`public Property`	`getMappedForm()`
	`public PropertyMapping<T>`	`getMapping()`
	`public PropertyMapping<T>`	`getMapping()`
	`public PropertyMapping<T>`	`getMapping()`
	`public PropertyMapping<T>`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public PropertyMapping`	`getMapping()`
	`public boolean`	`isCustomType(Class<?> propertyType)`
	`public boolean`	`isSimpleType(Class propType)`
	`public static boolean`	`isSimpleType(String typeName)`
	`public abstract boolean`	`isTenantId(PersistentEntity entity, MappingContext context, PropertyDescriptor descriptor)` Return whether the given property descriptor is the tenant id
	`public void`	`registerCustomType(CustomTypeMarshaller marshallerCustom)`
	`public String`	`toString()`
	`public String`	`toString()`
	`public String`	`toString()`
	`public String`	`toString()`
	`public String`	`toString()`
	`public String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final String IDENTITY_PROPERTY
  - public static final Set<String> SIMPLE_TYPES
- Method Detail
  - protected boolean allowArbitraryCustomTypes()
  - public static String associationtoString(String desc, Association a)
  - public Basic createBasicCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property, Class collectionType)
    
    Creates a Basic collection type
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The Basic collection type
  - public Basic createBasicCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
  - public Custom<T> createCustom(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)
    
    Creates a custom prpoerty type
    Parameters:
    owner - The owner
    context - The context
    pd - The PropertyDescriptor
    Returns:
    A custom property type
  - public IdentityMapping createDefaultIdentityMapping(ClassMapping classMapping)
  - protected IdentityMapping createDefaultIdentityMapping(ClassMapping classMapping, T property)
  - public Embedded createEmbedded(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
    
    Creates an Embedded type used to model an embedded association (composition)
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The Embedded instance
  - public EmbeddedCollection createEmbeddedCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
    
    Creates an EmbeddedCollection type used to model an embedded collection association (composition).
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The Embedded instance
  - public Identity<T> createIdentity(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)
    
    Creates an identifier property
    Parameters:
    owner - The owner
    context - The context
    pd - The PropertyDescriptor
    Returns:
    An Identity instance
  - public IdentityMapping createIdentityMapping(ClassMapping classMapping)
  - public ManyToMany createManyToMany(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
    
    Creates a ManyToMany type used to model a many-to-many association between entities
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The ManyToMany instance
  - public ToOne createManyToOne(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
    
    Creates a many-to-one association type used for a mapping a many-to-one association between entities
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The ToOne instance
  - public abstract R createMappedForm(PersistentEntity entity)
    
    Creates the mapped form of a persistent entity
    Parameters:
    entity - The entity
    Returns:
    The mapped form
  - public abstract T createMappedForm(PersistentProperty mpp)
    
    Creates the mapped form of a PersistentProperty instance
    Parameters:
    mpp - The PersistentProperty instance
    Returns:
    The mapped form
  - public OneToMany createOneToMany(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
    
    Creates a OneToMany type used to model a one-to-many association between entities
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The OneToMany instance
  - public ToOne createOneToOne(PersistentEntity entity, MappingContext context, PropertyDescriptor property)
    
    Creates a one-to-one association type used for mapping a one-to-one association between entities
    Parameters:
    entity - The entity
    context - The context
    property - The property
    Returns:
    The ToOne instance
  - public PropertyDescriptor createPropertyDescriptor(Class declaringClass, MetaProperty property)
    
    Creates a PropertyDescriptor from a MetaBeanProperty
    Parameters:
    property - The bean property
    Returns:
    The descriptor or null
  - protected PropertyMapping<T> createPropertyMapping(PersistentProperty<T> property, PersistentEntity owner)
  - public Simple<T> createSimple(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)
    
    Creates a simple property type used for mapping basic types such as String, long, integer etc.
    Parameters:
    owner - The owner
    context - The MappingContext
    pd - The PropertyDescriptor
    Returns:
    A Simple property type
  - public TenantId<T> createTenantId(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)
    
    Creates the tenant identifier property
    Parameters:
    owner - The owner
    context - The context
    pd - The PropertyDescriptor
    Returns:
    An Identity instance
  - protected CustomTypeMarshaller findCustomType(MappingContext context, Class<?> propertyType)
  - @Override
    public ClassMapping getClassMapping()
  - @Override
    public ClassMapping getClassMapping()
  - @Override
    public ClassMapping getClassMapping()
  - @Override
    public ClassMapping getClassMapping()
  - @Override
    public ValueGenerator getGenerator()
  - @Override
    public ValueGenerator getGenerator()
  - @Override
    public String[] getIdentifierName()
  - @Override
    public String[] getIdentifierName()
  - @Override
    public T getMappedForm()
  - @Override
    public T getMappedForm()
  - @Override
    public Property getMappedForm()
  - @Override
    public Property getMappedForm()
  - @Override
    public PropertyMapping<T> getMapping()
  - @Override
    public PropertyMapping<T> getMapping()
  - @Override
    public PropertyMapping<T> getMapping()
  - @Override
    public PropertyMapping<T> getMapping()
  - @Override
    public PropertyMapping getMapping()
  - @Override
    public PropertyMapping getMapping()
  - @Override
    public PropertyMapping getMapping()
  - public PropertyMapping getMapping()
  - @Override
    public PropertyMapping getMapping()
  - @Override
    public PropertyMapping getMapping()
  - @Override
    public PropertyMapping getMapping()
  - public boolean isCustomType(Class<?> propertyType)
  - public boolean isSimpleType(Class propType)
  - public static boolean isSimpleType(String typeName)
  - public abstract boolean isTenantId(PersistentEntity entity, MappingContext context, PropertyDescriptor descriptor)
    
    Return whether the given property descriptor is the tenant id
    Parameters:
    entity - The entity
    context - The context
    descriptor - The descriptor
    Returns:
    True if it is
  - public void registerCustomType(CustomTypeMarshaller marshallerCustom)
  - @Override
    public String toString()
  - @Override
    public String toString()
  - @Override
    public String toString()
  - @Override
    public String toString()
  - @Override
    public String toString()
  - @Override
    public String toString()

Summary:
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Java] Class MappingFactory<R extends Entity, T extends Property>

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String IDENTITY_PROPERTY

public static final Set<String> SIMPLE_TYPES

Method Detail

protected boolean allowArbitraryCustomTypes()

public static String associationtoString(String desc, Association a)

public Basic createBasicCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property, Class collectionType)

public Basic createBasicCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public Custom<T> createCustom(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)

public IdentityMapping createDefaultIdentityMapping(ClassMapping classMapping)

protected IdentityMapping createDefaultIdentityMapping(ClassMapping classMapping, T property)

public Embedded createEmbedded(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public EmbeddedCollection createEmbeddedCollection(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public Identity<T> createIdentity(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)

public IdentityMapping createIdentityMapping(ClassMapping classMapping)

public ManyToMany createManyToMany(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public ToOne createManyToOne(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public abstract R createMappedForm(PersistentEntity entity)

public abstract T createMappedForm(PersistentProperty mpp)

public OneToMany createOneToMany(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public ToOne createOneToOne(PersistentEntity entity, MappingContext context, PropertyDescriptor property)

public PropertyDescriptor createPropertyDescriptor(Class declaringClass, MetaProperty property)

protected PropertyMapping<T> createPropertyMapping(PersistentProperty<T> property, PersistentEntity owner)

public Simple<T> createSimple(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)

public TenantId<T> createTenantId(PersistentEntity owner, MappingContext context, PropertyDescriptor pd)

protected CustomTypeMarshaller findCustomType(MappingContext context, Class<?> propertyType)

@Overridepublic ClassMapping getClassMapping()

@Overridepublic ClassMapping getClassMapping()

@Overridepublic ClassMapping getClassMapping()

@Overridepublic ClassMapping getClassMapping()

@Overridepublic ValueGenerator getGenerator()

@Overridepublic ValueGenerator getGenerator()

@Overridepublic String[] getIdentifierName()

@Overridepublic String[] getIdentifierName()

@Overridepublic T getMappedForm()

@Overridepublic T getMappedForm()

@Overridepublic Property getMappedForm()

@Overridepublic Property getMappedForm()

@Overridepublic PropertyMapping<T> getMapping()

@Overridepublic PropertyMapping<T> getMapping()

@Overridepublic PropertyMapping<T> getMapping()

@Overridepublic PropertyMapping<T> getMapping()

@Overridepublic PropertyMapping getMapping()

@Overridepublic PropertyMapping getMapping()

@Overridepublic PropertyMapping getMapping()

public PropertyMapping getMapping()

@Overridepublic PropertyMapping getMapping()

@Overridepublic PropertyMapping getMapping()

@Overridepublic PropertyMapping getMapping()

public boolean isCustomType(Class<?> propertyType)

public boolean isSimpleType(Class propType)

public static boolean isSimpleType(String typeName)

public abstract boolean isTenantId(PersistentEntity entity, MappingContext context, PropertyDescriptor descriptor)

public void registerCustomType(CustomTypeMarshaller marshallerCustom)

@Overridepublic String toString()

@Overridepublic String toString()

@Overridepublic String toString()

@Overridepublic String toString()

@Overridepublic String toString()

@Overridepublic String toString()

@Override
public ClassMapping getClassMapping()

@Override
public ClassMapping getClassMapping()

@Override
public ClassMapping getClassMapping()

@Override
public ClassMapping getClassMapping()

@Override
public ValueGenerator getGenerator()

@Override
public ValueGenerator getGenerator()

@Override
public String[] getIdentifierName()

@Override
public String[] getIdentifierName()

@Override
public T getMappedForm()

@Override
public T getMappedForm()

@Override
public Property getMappedForm()

@Override
public Property getMappedForm()

@Override
public PropertyMapping<T> getMapping()

@Override
public PropertyMapping<T> getMapping()

@Override
public PropertyMapping<T> getMapping()

@Override
public PropertyMapping<T> getMapping()

@Override
public PropertyMapping getMapping()

@Override
public PropertyMapping getMapping()

@Override
public PropertyMapping getMapping()

@Override
public PropertyMapping getMapping()

@Override
public PropertyMapping getMapping()

@Override
public PropertyMapping getMapping()

@Override
public String toString()

@Override
public String toString()

@Override
public String toString()

@Override
public String toString()

@Override
public String toString()

@Override
public String toString()