org.spicefactory.pimento.io
Interface EntitySnapshot

All Known Subinterfaces:

ApplicableEntitySnapshot

All Known Implementing Classes:

AbstractApplicableEntitySnapshot, AbstractEntitySnapshot, FullEntitySnapshot, PartialEntitySnapshot, ProxyEntitySnapshot

public interface EntitySnapshot

The core IO interface, representing a single disassembled entity (or only parts of it).

Author:

Jens Halm

Method Summary

Object	getEntityId() Returns the id of the entity.
String	getLogString(EntityMetadata metadata, boolean includeProperties) Returns a log String for this snapshot.
int	getMetadataId() Returns the id of the associated metadata.

Method Detail

getMetadataId

int getMetadataId()

Returns the id of the associated metadata. A unique id will be assigned for each persistent class in the JPA configuration that was configured to be managed by Pimento.

Returns:

the id of the associated metadata

getEntityId

Object getEntityId()

Returns the id of the entity. For transient entities a temporary id will be used.

Returns:

the id of the entity

getLogString

String getLogString(EntityMetadata metadata,
                    boolean includeProperties)

Returns a log String for this snapshot.

Parameters:

metadata - the metadata associated with this snapshot

includeProperties - whether properties should be included in the log