oracle.lite.sync

Class DownloadInfo

java.lang.Object

oracle.lite.sync.DownloadInfo

public class DownloadInfo
extends java.lang.Object

This class is used by the getDownloadInfo method in the ConsolidatorManager class. When getDownloadInfo is called, it returns an object of this class which contains a HashSet of PublicationSize objects. Each PublicationSize object contains the size information of a Publication Item. This class also provides getter methods for the size information. An iterator method is also available so that the user can traverse the HashSet. But please be aware that it is not thread-safe and is fail-fast. There are two naming convention: 1) Template and publication; 2) and publication and publication item. And this class uses the latter one.

See Also:

ConsolidatorManager, PublicationSize

Method Summary

Methods

Modifier and Type	Method and Description
int	getPubItemRecCount(java.lang.String pubItemName) This will return the number of records of the Publication Item referred by pubItemName that will be synced in the next synchronization.
long	getPubItemSize(java.lang.String pubItemName) This will return the size of a particular Publication Item referred by pubItemName.
int	getPubRecCount(java.lang.String pubName) This will return the number of all records of all the Publication Items that belong to the Publication referred by pubName, that will be synced in the next synchronization.
long	getPubSize(java.lang.String pubName) This will return the size of all Publication Items that belong to the Publication referred by pubName.
long	getTotalSize() This will return the size information of all PublicationSize objects.
java.util.Iterator	iterator() This will return an Iterator object so that the user can traverse through all the PublicationSize objects that are contained inside the DownloadInfo object.
int	size() Returns the number of Publication Items in the set.

Methods inherited from class java.lang.Object

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

Method Detail

getPubItemRecCount

public int getPubItemRecCount(java.lang.String pubItemName)

This will return the number of records of the Publication Item referred by pubItemName that will be synced in the next synchronization.

Parameters:

pubItemName - The name of the Publication Item.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 int pubItemRecCount = dlInfo.getPubItemRecCount ("somePubItemName");
 

Returns:

The number of records of the Publication Item in int.

getPubItemSize

public long getPubItemSize(java.lang.String pubItemName)

This will return the size of a particular Publication Item referred by pubItemName. It follows the following rules in order: 1. If the publication item is empty, it will return 0. 2. If no historical information is available for those Publication Items, it will return -1.

Parameters:

pubItemName - The name of the Publication Item.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 long pubItemSize = dlInfo.getPubItemSize ("somePubItemName");
 

Returns:

The publication item size in long.

getPubRecCount

public int getPubRecCount(java.lang.String pubName)

This will return the number of all records of all the Publication Items that belong to the Publication referred by pubName, that will be synced in the next synchronization.

Parameters:

pubName - The name of the Publication.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 int pubRecCount = dlInfo.getPubRecCount ("somePubName");
 

Returns:

The number of records in int.

getPubSize

public long getPubSize(java.lang.String pubName)

This will return the size of all Publication Items that belong to the Publication referred by pubName. If no historical information is available for all of the Publication Items, it will return -1.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 long pubSize = dlInfo.getPubSize ("somePubName");
 

Parameters:

pubName - The name of the Publication.

Returns:

The publication size in long.

getTotalSize

public long getTotalSize()

This will return the size information of all PublicationSize objects. Thus, the size of all Publication Items that are subscribed to the Consolidator user. If no historical information is available for all those Publication Items, it will return -1>.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 long totalSize = dlInfo.getTotalSize ();
 

Returns:

The total size in long.

iterator

public java.util.Iterator iterator()

This will return an Iterator object so that the user can traverse through all the PublicationSize objects that are contained inside the DownloadInfo object. Please be aware that it is not thread safe and is fail-fast.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 Iterator it = dlInfo.iterator ();
 

Returns:

An Iterator object which can be used to tranverse all the PublicationSize objects in the set.

size

public int size()

Returns the number of Publication Items in the set.

Returns:

An int indicating the number of Publication Items in the list.

Example:

 ConsolidatorManager cm = new ConsolidatorManager();
 DownloadInfo dlInfo = cm.getDownloadInfo ("S11U1", true, true);
 int size = dlInfo.size ();