|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.search.indexing.config.RepositoryIterator
public class RepositoryIterator
An instance of this class can be configured to act as an iterator through a repository
for a given item descriptor.
It will load repository items in batches to avoid performance problems with large repository
sets.
It is also possible to start iterating from a specific repository id.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static ApplicationLogging |
mLogger
Logger |
Constructor Summary | |
---|---|
RepositoryIterator(Repository pRepository,
java.lang.String pItemDescriptorName,
int pBatchSize,
javax.transaction.TransactionManager pTransactionManager,
java.lang.String pIdPropertyName)
|
|
RepositoryIterator(Repository pRepository,
java.lang.String pItemDescriptorName,
int pBatchSize,
javax.transaction.TransactionManager pTransactionManager,
java.lang.String pIdPropertyName,
boolean pAutoFetchNextBatch,
int pStartIndex,
boolean pPreLoadBatch)
|
Method Summary | |
---|---|
protected void |
doReset()
Initializes member variables required for this iterator to work. |
java.util.List<java.lang.String> |
getBatchesStartIndexes()
Gets a list of the start indexes for every batch processed by this repository iterator instance. |
int |
getBatchSize()
|
java.lang.String |
getIdPropertyName()
|
java.lang.String |
getItemDescriptorName()
|
ApplicationLogging |
getLogger()
|
int |
getNumItems()
|
Repository |
getRepository()
|
javax.transaction.TransactionManager |
getTransactionManager()
|
boolean |
hasNext()
|
boolean |
isAutoFetchNextBatch()
|
protected void |
loadBatch()
|
RepositoryItem |
next()
|
void |
reset()
|
void |
reset(int pStartIndex)
Resets this iterator. |
void |
setAutoFetchNextBatch(boolean autoFetchNextBatch)
|
void |
setBatchSize(int pBatchSize)
|
void |
setStartIndex(int pIndex)
Forces the iterator to start using a batch from the given index position. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
public static ApplicationLogging mLogger
Constructor Detail |
---|
public RepositoryIterator(Repository pRepository, java.lang.String pItemDescriptorName, int pBatchSize, javax.transaction.TransactionManager pTransactionManager, java.lang.String pIdPropertyName) throws RepositoryException, TransactionDemarcationException
RepositoryException
TransactionDemarcationException
public RepositoryIterator(Repository pRepository, java.lang.String pItemDescriptorName, int pBatchSize, javax.transaction.TransactionManager pTransactionManager, java.lang.String pIdPropertyName, boolean pAutoFetchNextBatch, int pStartIndex, boolean pPreLoadBatch) throws RepositoryException, TransactionDemarcationException
pRepository
- pItemDescriptorName
- pBatchSize
- pTransactionManager
- pIdPropertyName
- pAutoFetchNextBatch
- pStartIndex
- pPreLoadBatch
-
RepositoryException
TransactionDemarcationException
Method Detail |
---|
public Repository getRepository()
public java.lang.String getItemDescriptorName()
public void setBatchSize(int pBatchSize)
public int getBatchSize()
public javax.transaction.TransactionManager getTransactionManager()
public java.lang.String getIdPropertyName()
public boolean isAutoFetchNextBatch()
public void setAutoFetchNextBatch(boolean autoFetchNextBatch)
public boolean hasNext() throws RepositoryException, TransactionDemarcationException
RepositoryException
TransactionDemarcationException
public RepositoryItem next() throws RepositoryException, TransactionDemarcationException
RepositoryException
TransactionDemarcationException
public void reset() throws RepositoryException, TransactionDemarcationException
RepositoryException
TransactionDemarcationException
public void reset(int pStartIndex) throws RepositoryException, TransactionDemarcationException
pStartIndex
- Starting index for fetching repository data
RepositoryException
TransactionDemarcationException
protected void doReset() throws RepositoryException, TransactionDemarcationException
RepositoryException
TransactionDemarcationException
public java.util.List<java.lang.String> getBatchesStartIndexes()
public void setStartIndex(int pIndex) throws RepositoryException, TransactionDemarcationException
pIndex
- int index to start batch from.
RepositoryException
TransactionDemarcationException
public int getNumItems()
protected void loadBatch() throws RepositoryException, TransactionDemarcationException
RepositoryException
TransactionDemarcationException
public ApplicationLogging getLogger()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |