Package de.elo.ix.client

Class NavigationInfo

java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.NavigationInfo

All Implemented Interfaces:

Serializable

public class NavigationInfo
extends ValueClass
implements Serializable

NavigationInfo is used as traversal information for structured bulk operations restricting specific processsing, e.g. pooled jobs, to scalable amounts. It provides parameters controlling the traversal.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FindInfo	findInfo	Specify additional filters for the tree walk.
protected boolean	ignoreDocuments	ignore the navigation of documents
protected int	maxCount	maxCount is the overall maximum amount of visited nodes and is independent of successful processing.
protected int	maxDepth	The maximum depth of the tree walk.
protected int	maxSiblings	The maximum number of siblings for one tree level.
protected String[]	startIDs	The starting points for the tree walk.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor	Description
NavigationInfo()
NavigationInfo(boolean ignoreDocuments, int maxCount, int maxDepth, int maxSiblings, String[] startIDs)
NavigationInfo(NavigationInfo rhs)

Method Summary

Modifier and Type	Method	Description
FindInfo	getFindInfo()
int	getMaxCount()
int	getMaxDepth()
int	getMaxSiblings()
String[]	getStartIDs()
boolean	isIgnoreDocuments()
void	setFindInfo(FindInfo findInfo)
void	setIgnoreDocuments(boolean ignoreDocuments)
void	setMaxCount(int maxCount)
void	setMaxDepth(int maxDepth)
void	setMaxSiblings(int maxSiblings)
void	setStartIDs(String[] startIDs)
String	toString()

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

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

Field Details

ignoreDocuments

protected boolean ignoreDocuments

ignore the navigation of documents

maxCount

protected int maxCount

maxCount is the overall maximum amount of visited nodes and is independent of successful processing. maxCount does not depend on successful processing to be incremented, and it can stop the traversal before any of the other limits have been reached. Passing maxCount < 1 will turn off this limit.

maxDepth

protected int maxDepth

The maximum depth of the tree walk. Passing maxDepth < 1 turns off this limit.

maxSiblings

protected int maxSiblings

The maximum number of siblings for one tree level. This limit is most useful for ignoring the contents of large folders. Passing maxSiblings < 1 will turn the limit off.

startIDs

protected String[] startIDs

The starting points for the tree walk. Interdepending nodes will only be traversed once. Providing null causes an invalid parameter exception, while unresolvable IDs or GUIDs will simply be ignored.

findInfo

protected FindInfo findInfo

Specify additional filters for the tree walk.

Please note that specifying a custom findInfo always leads to a second search for each directory decreasing the overall performance. Use this only if processFindResult is not suitable.

Then, not every feature is supported which findInfo offers. Firstly, the member findChildren will be overwritten during the tree walk. Secondly, as a fulltext or direct search respectively influence the search for children, they are unsupported also.

Since:

9.00.014.007

Constructor Details

NavigationInfo

public NavigationInfo()

NavigationInfo

public NavigationInfo(boolean ignoreDocuments,
 int maxCount,
 int maxDepth,
 int maxSiblings,
 String[] startIDs)

NavigationInfo

public NavigationInfo(NavigationInfo rhs)

Method Details

isIgnoreDocuments

public boolean isIgnoreDocuments()

setIgnoreDocuments

public void setIgnoreDocuments(boolean ignoreDocuments)

getMaxCount

public int getMaxCount()

setMaxCount

public void setMaxCount(int maxCount)

getMaxDepth

public int getMaxDepth()

setMaxDepth

public void setMaxDepth(int maxDepth)

getMaxSiblings

public int getMaxSiblings()

setMaxSiblings

public void setMaxSiblings(int maxSiblings)

getStartIDs

public String[] getStartIDs()

setStartIDs

public void setStartIDs(String[] startIDs)

getFindInfo

public FindInfo getFindInfo()

setFindInfo

public void setFindInfo(FindInfo findInfo)

toString

public String toString()

Overrides:

toString in class Object