org.mymedialite.data
Interface IEntityMapping

All Known Subinterfaces:
IHierarchicalEntityMapping
All Known Implementing Classes:
EntityMapping, HierarchicalEntityMapping, IdentityMapping

public interface IEntityMapping

Interface to map external entity IDs to internal ones to ensure that there are no gaps in the numbering.


Method Summary
 java.util.Collection<java.lang.Integer> internalIDs()
          Get all internal entity IDs.
 java.util.Collection<java.lang.String> originalIDs()
          Get all original (external) entity IDs.
 IntList toInternalID(java.util.List<java.lang.String> original_id_list)
          Get internal IDs of a list of given entities.
 java.lang.Integer toInternalID(java.lang.String original_id)
          Get internal ID of a given entity.
 java.lang.String toOriginalID(int internal_id)
          Get the original (external) ID of a given entity, if the given internal ID is unknown, throw an exception.
 java.util.List<java.lang.String> toOriginalID(IntList internal_id_list)
          Get the original (external) IDs of a list of given entities.
 

Method Detail

originalIDs

java.util.Collection<java.lang.String> originalIDs()
Get all original (external) entity IDs.


internalIDs

java.util.Collection<java.lang.Integer> internalIDs()
Get all internal entity IDs.


toOriginalID

java.lang.String toOriginalID(int internal_id)
Get the original (external) ID of a given entity, if the given internal ID is unknown, throw an exception.

Parameters:
internal_id - the internal ID of the entity.
Returns:
the original (external) ID of the entity.

toInternalID

java.lang.Integer toInternalID(java.lang.String original_id)
Get internal ID of a given entity. If the given external ID is unknown, create a new internal ID for it and store the mapping.

Parameters:
original_id - the original (external) ID of the entity.
Returns:
the internal ID of the entity.

toOriginalID

java.util.List<java.lang.String> toOriginalID(IntList internal_id_list)
Get the original (external) IDs of a list of given entities.

Parameters:
internal_id_list - the list of internal IDs.
Returns:
the list of original (external) IDs.

toInternalID

IntList toInternalID(java.util.List<java.lang.String> original_id_list)
Get internal IDs of a list of given entities.

Parameters:
original_id_list - the list of original (external) IDs.
Returns:
a list of internal IDs.