PersistentEntity (GORM for MongoDB

org.grails.datastore.mapping.model.lifecycle.Initializable

All Superinterfaces:: Initializable

@java.lang.SuppressWarnings("rawtypes")
public interface PersistentEntity
extends Initializable

Represents a persistent entity.

Authors:: Graeme Rocher

Since:: 1.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public boolean`	`addOwner(java.lang.Class type)` Add a class to the owners list of this PersistentEntity
	`public java.util.List<Association>`	`getAssociations()` A list of the associations for this entity.
	`public PersistentProperty[]`	`getCompositeIdentity()` The composite id
	`public java.lang.String`	`getDecapitalizedName()` Returns: Returns the name of the class decapitalized form
	`public java.lang.String`	`getDiscriminator()` The discriminator used when persisting subclasses of an inheritance hierarchy
	`public java.util.List<Embedded>`	`getEmbedded()` A list of embedded associations for this entity.
	`public PersistentProperty`	`getIdentity()` Returns the identity of the instance
	`public java.lang.Class`	`getJavaClass()` Returns: The underlying Java class for this entity
	`public ClassMapping`	`getMapping()` Defines the mapping between this persistent entity and an external form
	`public MappingContext`	`getMappingContext()` Obtains the MappingContext where this PersistentEntity is defined
	`public java.lang.String`	`getName()` The entity name including any package prefix
	`public PersistentEntity`	`getParentEntity()` Returns the parent entity of this entity
	`public java.util.List<PersistentProperty>`	`getPersistentProperties()` A list of properties to be persisted
	`public java.util.List<java.lang.String>`	`getPersistentPropertyNames()` A list of property names that a persistent
	`public PersistentProperty`	`getPropertyByName(java.lang.String name)` Obtains a PersistentProperty instance by name
	`public EntityReflector`	`getReflector()` Returns: The reflector this entity
	`public PersistentEntity`	`getRootEntity()` Obtains the root entity of an inheritance hierarchy
	`public TenantId`	`getTenantId()` Returns: The tenant id
	`public PersistentProperty`	`getVersion()` Returns the version property.
	`public boolean`	`hasProperty(java.lang.String name, java.lang.Class type)` Checks whether an entity has a bean property of the given name and type
	`public boolean`	`isExternal()` Whether this PersistentEntity is mapped using a different store.
	`public boolean`	`isIdentityName(java.lang.String propertyName)` True if the given property is the identifier
	`public boolean`	`isInstance(java.lang.Object obj)` Tests whether the given instance is an instance of this persistent entity
	`public boolean`	`isMultiTenant()` Returns: Whether the entity is multi tenant
	`public boolean`	`isOwningEntity(PersistentEntity owner)` Returns whether the specified entity asserts ownership over this entity
	`public boolean`	`isRoot()` Whether this entity is a root entity
	`public boolean`	`isVersioned()` Is the entity versioned for optimistic locking.
	`public java.lang.Object`	`newInstance()` Constructs a new instance
	`public void`	`setExternal(boolean external)` Whether this PersistentEntity is mapped using a different store.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface Initializable`	`initialize, isInitialized`

- Method Detail
  - public boolean addOwner(java.lang.Class type)
    
    Add a class to the owners list of this PersistentEntity
    Parameters:
    type - The class to add
    Returns:
    True if the operation was successful
  - public java.util.List<Association> getAssociations()
    
    A list of the associations for this entity. This is typically a subset of the list returned by getPersistentProperties()
    Returns:
    A list of associations
  - public PersistentProperty[] getCompositeIdentity()
    
    The composite id
    Returns:
    The composite id or null if there isn't one
  - public java.lang.String getDecapitalizedName()
    
    Returns:
    Returns the name of the class decapitalized form
  - public java.lang.String getDiscriminator()
    
    The discriminator used when persisting subclasses of an inheritance hierarchy
    Returns:
    The discriminator
  - public java.util.List<Embedded> getEmbedded()
    
    A list of embedded associations for this entity. This is typically a subset of the list returned by getPersistentProperties()
    Returns:
    A list of associations
  - public PersistentProperty getIdentity()
    
    Returns the identity of the instance
    Returns:
    The identity or null if there isn't one
  - public java.lang.Class getJavaClass()
    
    Returns:
    The underlying Java class for this entity
  - public ClassMapping getMapping()
    
    Defines the mapping between this persistent entity and an external form
    Returns:
    The ClassMapping instance
  - public MappingContext getMappingContext()
    
    Obtains the MappingContext where this PersistentEntity is defined
    Returns:
    The MappingContext instance
  - public java.lang.String getName()
    
    The entity name including any package prefix
    Returns:
    The entity name
  - public PersistentEntity getParentEntity()
    
    Returns the parent entity of this entity
    Returns:
    The ParentEntity instance
  - public java.util.List<PersistentProperty> getPersistentProperties()
    
    A list of properties to be persisted
    Returns:
    A list of PersistentProperty instances
  - public java.util.List<java.lang.String> getPersistentPropertyNames()
    
    A list of property names that a persistent
    Returns:
    A List of strings
  - public PersistentProperty getPropertyByName(java.lang.String name)
    
    Obtains a PersistentProperty instance by name
    Parameters:
    name - The name of the property
    Returns:
    The PersistentProperty or null if it doesn't exist
  - public EntityReflector getReflector()
    
    Returns:
    The reflector this entity
  - public PersistentEntity getRootEntity()
    
    Obtains the root entity of an inheritance hierarchy
    Returns:
    The root entity
  - public TenantId getTenantId()
    
    Returns:
    The tenant id
  - public PersistentProperty getVersion()
    
    Returns the version property.
    Returns:
    the property
  - public boolean hasProperty(java.lang.String name, java.lang.Class type)
    
    Checks whether an entity has a bean property of the given name and type
    Parameters:
    name - The name
    type - The type
    Returns:
    True if it does
  - public boolean isExternal()
    
    Whether this PersistentEntity is mapped using a different store. Used for cross store persistence.
    Returns:
    true if this entity is externally mapped
  - public boolean isIdentityName(java.lang.String propertyName)
    
    True if the given property is the identifier
    Parameters:
    propertyName - the property name
    Returns:
    True if it is the identifier
  - public boolean isInstance(java.lang.Object obj)
    
    Tests whether the given instance is an instance of this persistent entity
    Parameters:
    obj - The object
    Returns:
    True if it is
  - public boolean isMultiTenant()
    
    Returns:
    Whether the entity is multi tenant
  - public boolean isOwningEntity(PersistentEntity owner)
    
    Returns whether the specified entity asserts ownership over this entity
    Parameters:
    owner - The owning entity
    Returns:
    True if it does own this entity
  - public boolean isRoot()
    
    Whether this entity is a root entity
    Returns:
    True if it is a root entity
  - public boolean isVersioned()
    
    Is the entity versioned for optimistic locking.
    Returns:
    true if versioned
  - public java.lang.Object newInstance()
    
    Constructs a new instance
    Returns:
    The new instnace
  - public void setExternal(boolean external)
    
    Whether this PersistentEntity is mapped using a different store. Used for cross store persistence.
    Parameters:
    external - true if this entity is externally mapped

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface PersistentEntity

Methods Summary

Inherited Methods Summary

Method Detail

public boolean addOwner(java.lang.Class type)

public java.util.List<Association> getAssociations()

public PersistentProperty[] getCompositeIdentity()

public java.lang.String getDecapitalizedName()

public java.lang.String getDiscriminator()

public java.util.List<Embedded> getEmbedded()

public PersistentProperty getIdentity()

public java.lang.Class getJavaClass()

public ClassMapping getMapping()

public MappingContext getMappingContext()

public java.lang.String getName()

public PersistentEntity getParentEntity()

public java.util.List<PersistentProperty> getPersistentProperties()

public java.util.List<java.lang.String> getPersistentPropertyNames()

public PersistentProperty getPropertyByName(java.lang.String name)

public EntityReflector getReflector()

public PersistentEntity getRootEntity()

public TenantId getTenantId()

public PersistentProperty getVersion()

public boolean hasProperty(java.lang.String name, java.lang.Class type)

public boolean isExternal()

public boolean isIdentityName(java.lang.String propertyName)

public boolean isInstance(java.lang.Object obj)

public boolean isMultiTenant()

public boolean isOwningEntity(PersistentEntity owner)

public boolean isRoot()

public boolean isVersioned()

public java.lang.Object newInstance()

public void setExternal(boolean external)