com.helger.commons.tree.withid.unique

Class BasicTreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

java.lang.Object

com.helger.commons.tree.withid.BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>

com.helger.commons.tree.withid.unique.BasicTreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE>

Type Parameters:

KEYTYPE - The type of the key elements for the tree.

DATATYPE - The type of the elements contained in the tree

ITEMTYPE - tree item type

All Implemented Interfaces:

IChildrenProvider<ITEMTYPE>, IChildrenProviderWithID<KEYTYPE,ITEMTYPE>, IHasChildren<ITEMTYPE>, IBasicTree<DATATYPE,ITEMTYPE>, ITreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>, ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE>

Direct Known Subclasses:

BasicFolderTree, DefaultTreeWithGlobalUniqueID

@NotThreadSafe
public class BasicTreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>
extends BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>
implements ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE>

A managed tree is a specialized version of the tree, where each item is required to have a unique ID so that item searching can be performed quite easily.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicTreeWithGlobalUniqueID(ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsItemWithID(KEYTYPE aDataID) Check if a tree item corresponding to the given ID is present.
boolean	equals(Object o)
List<? extends ITEMTYPE>	getAllChildren(ITEMTYPE aItem) Get the children of the passed object.
Collection<DATATYPE>	getAllItemDatas()
Collection<ITEMTYPE>	getAllItems()
int	getChildCount(ITEMTYPE aItem)
ITEMTYPE	getChildWithID(ITEMTYPE aCurrentItem, KEYTYPE aDataID) Retrieve the objects with the passed ID or null if no such object.
protected ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>	getFactory()
int	getItemCount()
DATATYPE	getItemDataWithID(KEYTYPE aDataID) Get the data of the tree item that corresponds to the given ID.
ITEMTYPE	getItemWithID(KEYTYPE aDataID) Get the ITreeItemWithID that corresponds to the given ID.
boolean	hasChildren(ITEMTYPE aItem) Check if an item has children.
int	hashCode()
boolean	isItemSameOrDescendant(KEYTYPE aParentItemID, KEYTYPE aChildItemID) Check if one item is equal or a child of the other item.
EChange	removeItemWithID(KEYTYPE aDataID) Remove the item with the specified ID
String	toString()

Methods inherited from class com.helger.commons.tree.withid.BasicTreeWithID

getAllChildren, getChildCount, getRootItem, hasChildren

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.tree.IBasicTree

getRootItem

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

getAllChildren, getChildCount, hasChildren

Constructor Detail

BasicTreeWithGlobalUniqueID

public BasicTreeWithGlobalUniqueID(@Nonnull
                           ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory)

Method Detail

getFactory

@Nonnull
protected final ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> getFactory()

Returns:

The factory used for creation. For internal use only.

containsItemWithID

public final boolean containsItemWithID(@Nullable
                         KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Check if a tree item corresponding to the given ID is present.

Specified by:

containsItemWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID of the tree item to search.

Returns:

true if such an item is present

getItemWithID

@Nullable
public final ITEMTYPE getItemWithID(@Nullable
                              KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Get the ITreeItemWithID that corresponds to the given ID.

Specified by:

getItemWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID of the tree item to search.

Returns:

null if no such tree item exists.

getItemDataWithID

@Nullable
public final DATATYPE getItemDataWithID(@Nullable
                                  KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Get the data of the tree item that corresponds to the given ID.

Specified by:

getItemDataWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID of the tree item to search.

Returns:

null if no such tree item exists.

getChildWithID

@Nullable
public final ITEMTYPE getChildWithID(@Nullable
                               ITEMTYPE aCurrentItem,
                               @Nullable
                               KEYTYPE aDataID)

Description copied from interface: IChildrenProviderWithID

Retrieve the objects with the passed ID or null if no such object.

Specified by:

getChildWithID in interface IChildrenProviderWithID<KEYTYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aCurrentItem - The object to determine the children of. No null or non- null constraint possible.

aDataID - the ID of the object in question. No null or non- null constraint possible.

Returns:

the object with the passed ID or null

getItemCount

@Nonnegative
public final int getItemCount()

Specified by:

getItemCount in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The number of all contained items. Always ≥ 0.

getAllItems

@Nonnull
@ReturnsMutableCopy
public final Collection<ITEMTYPE> getAllItems()

Specified by:

getAllItems in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

A non-null collection of all items.

getAllItemDatas

@Nonnull
@ReturnsMutableCopy
public final Collection<DATATYPE> getAllItemDatas()

Specified by:

getAllItemDatas in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

A non-null collection of all item datas.

removeItemWithID

@Nonnull
public final EChange removeItemWithID(@Nullable
                               KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Remove the item with the specified ID

Specified by:

removeItemWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID of the item to be removed

Returns:

EChange.CHANGED if the item was removed, EChange.UNCHANGED otherwise. Never null.

isItemSameOrDescendant

public final boolean isItemSameOrDescendant(@Nullable
                             KEYTYPE aParentItemID,
                             @Nullable
                             KEYTYPE aChildItemID)

Description copied from interface: ITreeWithGlobalUniqueID

Check if one item is equal or a child of the other item. This relationship is checked not only for direct children but for all levels.

Specified by:

isItemSameOrDescendant in interface ITreeWithGlobalUniqueID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aParentItemID - The parent item ID to a validate.

aChildItemID - The item ID to check whether it is a child of the passed parent folder.

Returns:

true if the child item is the same or a child of the parent item, false if one of the IDs could not be resolved or they are not in a parent-child-relationship.

hasChildren

public boolean hasChildren(@Nullable
                  ITEMTYPE aItem)

Description copied from interface: IChildrenProvider

Check if an item has children.

Specified by:

hasChildren in interface IChildrenProvider<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aItem - The object to determine the children of. No null or non- null constraint possible.

Returns:

true if this item has children, false otherwise.

getChildCount

@Nonnegative
public int getChildCount(@Nullable
                            ITEMTYPE aItem)

Specified by:

getChildCount in interface IChildrenProvider<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aItem - The object to determine the children count of. No null or non- null constraint possible.

Returns:

The number of contained direct children. Always ≥ 0.

getAllChildren

@Nullable
public List<? extends ITEMTYPE> getAllChildren(@Nullable
                                               ITEMTYPE aItem)

Description copied from interface: IChildrenProvider

Get the children of the passed object.

Specified by:

getAllChildren in interface IChildrenProvider<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aItem - The object to determine the children of. No null or non-null constraint possible.

Returns:

The child objects, or null if there are no children. If null is passed, the resolver is expected to return any possible top level (root) elements. This method may NOT return null if the call to IChildrenProvider.hasChildren(Object) with the same object returned true.

equals

public boolean equals(Object o)

Overrides:

equals in class BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

hashCode

public int hashCode()

Overrides:

hashCode in class BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

toString

public String toString()

Overrides:

toString in class BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>