IEntityMapping Interface Reference

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

Inheritance diagram for IEntityMapping:
EntityMapping IdentityMapping

List of all members.

Public Member Functions

IList< int > ToInternalID (IList< string > original_id_list)
 Get internal IDs of a list of given entities.
int ToInternalID (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.
IList< string > ToOriginalID (IList< int > internal_id_list)
 Get original (external) IDs of a list of given entities.
string ToOriginalID (int internal_id)
 Get original (external) ID of a given entity, if the given internal ID is unknown, throw an exception.

Properties

ICollection< int > InternalIDs [get]
 all internal entity IDs
int NumberOfEntities [get]
 the number of entities
ICollection< string > OriginalIDs [get]
 all original (external) entity IDs

Detailed Description

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


Member Function Documentation

IList<int> ToInternalID ( IList< 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

Implemented in EntityMapping, and IdentityMapping.

int ToInternalID ( 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 entitiy

Implemented in EntityMapping, and IdentityMapping.

IList<string> ToOriginalID ( IList< int >  internal_id_list  ) 

Get 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

Implemented in EntityMapping, and IdentityMapping.

string ToOriginalID ( int  internal_id  ) 

Get 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 entitiy

Implemented in EntityMapping, and IdentityMapping.


Property Documentation

ICollection<int> InternalIDs [get]

all internal entity IDs

all internal entity IDs

Implemented in EntityMapping, and IdentityMapping.

int NumberOfEntities [get]

the number of entities

Implemented in EntityMapping, and IdentityMapping.

ICollection<string> OriginalIDs [get]

all original (external) entity IDs

all original (external) entity IDs

Implemented in EntityMapping, and IdentityMapping.


The documentation for this interface was generated from the following file:
Generated on Fri Mar 2 21:19:31 2012 for MyMediaLite by  doxygen 1.6.3