oracle.ifs.admin.tools.fingerprint

Class IdCache

java.lang.Object

oracle.ifs.admin.tools.fingerprint.IdCache

public class IdCache
extends Object

Implements a cache from a LibraryObject ID to a generated reference ID.

(Unpublished)

Method Summary

Modifier and Type	Method and Description
void	endObjectDump(LibraryObject lo) Marks that the given LibaryObject was fully dumped.
String	get(LibraryObject lo) Returns the reference ID of the object or null if the object is not cached.
static IdCache	getGlobalInstance() Returns the global cache instance.
boolean	needsDump(LibraryObject lo) Returns true if the given object was put in the cache (hence referenced) but not yet fully dumped.
String	put(LibraryObject lo, LibraryObject parentLO, String parentAttrName) Puts an object in the cache, returning the generated reference ID.
void	startObjectDump(LibraryObject lo) Called at the start of the dump process for a given object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getGlobalInstance

public static IdCache getGlobalInstance()

Returns the global cache instance.

Returns:

the global cache instance

(Unpublished)

get

public String get(LibraryObject lo)
           throws IfsException

Returns the reference ID of the object or null if the object is not cached.

Parameters:

lo - the object

Returns:

the reference ID or null if the object is not in the cache

Throws:

IfsException - if the operation fails

(Unpublished)

put

public String put(LibraryObject lo,
                  LibraryObject parentLO,
                  String parentAttrName)
           throws IfsException

Puts an object in the cache, returning the generated reference ID. Once an object is in the cache it cannot be added again.

Parameters:

lo - the current object

parentLO - the parent LO that the current LO was retrieved from. Can be null

parentAttrName - the attribute name of the parrent LO that the current LO was retrieved from. Can be null

Returns:

the generated reference ID

Throws:

IfsException - if the operation fails

(Unpublished)

startObjectDump

public void startObjectDump(LibraryObject lo)
                     throws IfsException

Called at the start of the dump process for a given object.

Parameters:

lo - the object

Throws:

IfsException - if the operation fails

(Unpublished)

endObjectDump

public void endObjectDump(LibraryObject lo)
                   throws IfsException

Marks that the given LibaryObject was fully dumped.

Parameters:

lo - the object to mark

Throws:

IfsException - if the operation fails

(Unpublished)

needsDump

public boolean needsDump(LibraryObject lo)
                  throws IfsException

Returns true if the given object was put in the cache (hence referenced) but not yet fully dumped.

Parameters:

lo - the object

Returns:

true if the object needs to be fully dumped

Throws:

IfsException - if the operation fails

(Unpublished)