ilog.cpl.datasource
Interface IlpIdentifierFactory


public interface IlpIdentifierFactory

This interface allows you to specify a way of changing the identifiers when loading data into a data source or writing it to XML.

Since:
JTGO 3.0

Method Summary
 Object getIdentifier(Object previousIdentifier)
          Returns the new identifier of an object.
 

Method Detail

getIdentifier

Object getIdentifier(Object previousIdentifier)
Returns the new identifier of an object.

This method is called while parsing the data whenever an identifier has been read or is about to be written; that is, whenever an object is added, updated, or removed or when a structure is mentioned; that is, when mentioning a parent, a child, or link extremities.

Important note: the identifier factory must return the same identifier each time it is called with the same previousIdentifier. That is, it must generate the new identifier without a side effect, such as returning the previousIdentifier, or concatenate a fixed string to it for example, or it must keep track of the identifiers it has generated to avoid regenerating one wrongly each time it is called with a previousIdentifier already encountered.

Parameters:
previousIdentifier - The identifier read while loading the data.
Returns:
The new identifier to use instead of previousIdentifier.


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.   . All Rights Reserved.