com.phloc.commons.tree.withid

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

java.lang.Object

com.phloc.commons.tree.withid.BasicTreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>

Type Parameters:

KEYTYPE - tree item key type

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

IHasID<KEYTYPE>, IHasChildren<ITEMTYPE>, IHasChildrenSorted<ITEMTYPE>, IHasParent<ITEMTYPE>, IBasicTreeItem<DATATYPE,ITEMTYPE>, ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>

Direct Known Subclasses:

BasicFolderTreeItem, DefaultTreeItemWithID

@NotThreadSafe
public class BasicTreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>
extends Object
implements ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>

Basic tree item with ID implementation, independent of the implementation type.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicTreeItemWithID(ITEMTYPE aParent, KEYTYPE aDataID) Constructor for normal elements
BasicTreeItemWithID(ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory) Constructor for root object with a null data ID
BasicTreeItemWithID(ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory, KEYTYPE aDataID) Constructor for root object

Method Summary

Methods

Modifier and Type	Method and Description
ESuccess	changeParent(ITEMTYPE aNewParent) Change the parent node of this node to another node (subordination).
boolean	containsChildItemWithDataID(KEYTYPE aDataID) Check if a direct child item with the given ID is present
ITEMTYPE	createChildItem(KEYTYPE aDataID, DATATYPE aData) Add a direct child item to this item.
ITEMTYPE	createChildItem(KEYTYPE aDataID, DATATYPE aData, boolean bAllowOverwrite) Add a direct child item to this item.
boolean	equals(Object o)
Set<KEYTYPE>	getAllChildDataIDs()
List<DATATYPE>	getAllChildDatas() Get the data values of all contained children.
ITEMTYPE	getChildAtIndex(int nIndex) Get the child node at the specified index
int	getChildCount()
ITEMTYPE	getChildItemOfDataID(KEYTYPE aDataID) Find the direct child item with the given ID
List<ITEMTYPE>	getChildren()
DATATYPE	getData()
ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>	getFactory()
ITEMTYPE	getFirstChild() Get the first child node or null if no child is present
KEYTYPE	getID() Get the unique ID of this object.
ITEMTYPE	getLastChild() Get the last child node or null if no child is present
ITEMTYPE	getParent() Get the parent object of this object.
DATATYPE	getParentData()
KEYTYPE	getParentID()
boolean	hasChildren()
int	hashCode()
EChange	internalAddChild(KEYTYPE aDataID, ITEMTYPE aChild, boolean bAllowOverwrite) Add an existing direct child to this tree item.
boolean	isRootItem()
boolean	isSameOrChildOf(ITEMTYPE aParent) Check if this item is the same or a child of the passed item.
protected boolean	isValidData(DATATYPE aData) This method is called to validate a data object.
protected boolean	isValidDataID(KEYTYPE aDataID) This method is called to validate a data ID object.
EChange	removeAllChildren() Remove all children from this node.
EChange	removeChild(KEYTYPE aDataID) Remove the passed node as a direct child node from this node.
void	reorderChildrenByItems(Comparator<? super ITEMTYPE> aComparator) Reorder the child items based on the item itself.
void	setData(DATATYPE aData) Change the data associated with this node.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTreeItemWithID

public BasicTreeItemWithID(@Nonnull
                   ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory)

Constructor for root object with a null data ID

Parameters:

aFactory - The tree item factory to use. May not be null.

BasicTreeItemWithID

public BasicTreeItemWithID(@Nonnull
                   ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory,
                   @Nullable
                   KEYTYPE aDataID)

Constructor for root object

Parameters:

aFactory - The tree item factory to use. May not be null.

aDataID - The data ID to use for the root item. May be null.

BasicTreeItemWithID

public BasicTreeItemWithID(@Nonnull
                   ITEMTYPE aParent,
                   @Nonnull
                   KEYTYPE aDataID)

Constructor for normal elements

Parameters:

aParent - Parent item. May never be null since only the root has no parent.

aDataID - The ID of the new item. May not be null.

Method Detail

getFactory

@Nonnull
public final ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> getFactory()

Specified by:

getFactory in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The factory used to create instances of this interface.

isValidDataID

@OverrideOnDemand
protected boolean isValidDataID(KEYTYPE aDataID)

This method is called to validate a data ID object. This method may be overloaded in derived classes. The default implementation accepts all values.

Parameters:

aDataID - The value to validate.

Returns:

true if the ID is valid, false otherwise.

isValidData

@OverrideOnDemand
protected boolean isValidData(DATATYPE aData)

This method is called to validate a data object. This method may be overloaded in derived classes. The default implementation accepts all values.

Parameters:

aData - The value to validate.

Returns:

true if the ID is valid, false otherwise.

isRootItem

public final boolean isRootItem()

Specified by:

isRootItem in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

true if this is the internal root item without a parent, false if this is a public item.

getParent

@Nullable
public final ITEMTYPE getParent()

Description copied from interface: IHasParent

Get the parent object of this object.

Specified by:

getParent in interface IHasParent<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The parent object or null if this object has no parent.

getParentID

@Nullable
public final KEYTYPE getParentID()

Specified by:

getParentID in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The data ID of the parent item. May be null if no parent is present or depending on the validator.

getParentData

@Nullable
public final DATATYPE getParentData()

Specified by:

getParentData in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

the data associated with the parent node. May be null.

getID

@Nullable
public final KEYTYPE getID()

Description copied from interface: IHasID

Get the unique ID of this object. If the type is String than the returned value must match an XML NMToken expression (so e.g. no ':' in the ID)!

Specified by:

getID in interface IHasID<KEYTYPE>

Specified by:

getID in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The data ID of this item. May be null depending on the validator.

getData

@Nullable
public final DATATYPE getData()

Specified by:

getData in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

the data associated with this node. May be null.

hasChildren

public final boolean hasChildren()

Specified by:

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

Returns:

true if this item has direct children, false otherwise.

getChildCount

@Nonnegative
public final int getChildCount()

Specified by:

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

Returns:

The number of contained direct children. Always ≥ 0.

getChildren

@Nullable
@ReturnsMutableCopy
public final List<ITEMTYPE> getChildren()

Specified by:

getChildren in interface IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Specified by:

getChildren in interface IHasChildrenSorted<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

A ordered list of child elements. May be null if no children are present.

getAllChildDataIDs

@Nullable
@ReturnsMutableCopy
public final Set<KEYTYPE> getAllChildDataIDs()

Specified by:

getAllChildDataIDs in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

A set with the data IDs of all children. If this tree item does not have children, null if returned.

getAllChildDatas

@Nullable
@ReturnsMutableCopy
public final List<DATATYPE> getAllChildDatas()

Description copied from interface: IBasicTreeItem

Get the data values of all contained children.

Specified by:

getAllChildDatas in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

null if this item does not have children. Use IHasChildren.hasChildren() to check for the existence.

getChildAtIndex

@Nullable
public final ITEMTYPE getChildAtIndex(@Nonnegative
                                int nIndex)

Description copied from interface: IHasChildrenSorted

Get the child node at the specified index

Specified by:

getChildAtIndex in interface IHasChildrenSorted<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

nIndex - The index to be queried. May not be < 0 or ≥ the number of children

Returns:

The child at the specified index or null if the index is invalid.

getFirstChild

@Nullable
public ITEMTYPE getFirstChild()

Description copied from interface: IHasChildrenSorted

Get the first child node or null if no child is present

Specified by:

getFirstChild in interface IHasChildrenSorted<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The first child or null.

getLastChild

@Nullable
public ITEMTYPE getLastChild()

Description copied from interface: IHasChildrenSorted

Get the last child node or null if no child is present

Specified by:

getLastChild in interface IHasChildrenSorted<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The last child or null.

setData

public final void setData(@Nullable
           DATATYPE aData)

Description copied from interface: IBasicTreeItem

Change the data associated with this node.

Specified by:

setData in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aData - The data associated with this node. May be null.

createChildItem

@Nullable
public final ITEMTYPE createChildItem(@Nullable
                                KEYTYPE aDataID,
                                @Nullable
                                DATATYPE aData)

Description copied from interface: ITreeItemWithID

Add a direct child item to this item. If another item with the same ID is already contained, the item is automatically overwritten.

Specified by:

createChildItem in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - ID of the item to generate. May be null in rare circumstances.

aData - The data associated with this item.

Returns:

the created tree item

createChildItem

@Nullable
public final ITEMTYPE createChildItem(@Nullable
                                KEYTYPE aDataID,
                                @Nullable
                                DATATYPE aData,
                                boolean bAllowOverwrite)

Description copied from interface: ITreeItemWithID

Add a direct child item to this item.

Specified by:

createChildItem in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - ID of the item to generate. May not be null.

aData - The data associated with this item.

bAllowOverwrite - If true a potential existing child item with the same ID is overwritten.

Returns:

the created tree item or null if the data ID is already in use and bAllowOverwrite is false

containsChildItemWithDataID

public final boolean containsChildItemWithDataID(@Nullable
                                  KEYTYPE aDataID)

Description copied from interface: ITreeItemWithID

Check if a direct child item with the given ID is present

Specified by:

containsChildItemWithDataID in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID to search. May be null.

Returns:

true if this item has a child with the given ID, false otherwise

getChildItemOfDataID

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

Description copied from interface: ITreeItemWithID

Find the direct child item with the given ID

Specified by:

getChildItemOfDataID in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID to search. May be null.

Returns:

null if this item has no child with the given ID. The item otherwise.

isSameOrChildOf

public final boolean isSameOrChildOf(@Nonnull
                      ITEMTYPE aParent)

Description copied from interface: IBasicTreeItem

Check if this item is the same or a child of the passed item. This is not limited to direct children but to children on all levels.

Specified by:

isSameOrChildOf in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aParent - The parent item to check whether this is a child of it. May not be null.

Returns:

true if this is the same or a child of aParent.

changeParent

@Nonnull
public final ESuccess changeParent(@Nonnull
                            ITEMTYPE aNewParent)

Description copied from interface: IBasicTreeItem

Change the parent node of this node to another node (subordination).

Specified by:

changeParent in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aNewParent - The new parent to use. May not be null. To make it a root item, pass the owning tree's root item.

Returns:

ESuccess

internalAddChild

@Nonnull
public final EChange internalAddChild(@Nonnull
                               KEYTYPE aDataID,
                               @Nonnull
                               ITEMTYPE aChild,
                               boolean bAllowOverwrite)

Description copied from interface: ITreeItemWithID

Add an existing direct child to this tree item. Use only internally!

Specified by:

internalAddChild in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The data ID to use. May not be null.

aChild - The child to be added. May not be null.

bAllowOverwrite - if true existing elements are overwritten.

Returns:

EChange

removeChild

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

Description copied from interface: ITreeItemWithID

Remove the passed node as a direct child node from this node.

Specified by:

removeChild in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The ID of the element to be removed. May not be null

Returns:

EChange

removeAllChildren

@Nonnull
public final EChange removeAllChildren()

Description copied from interface: ITreeItemWithID

Remove all children from this node.

Specified by:

removeAllChildren in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

EChange

reorderChildrenByItems

public final void reorderChildrenByItems(@Nonnull
                          Comparator<? super ITEMTYPE> aComparator)

Description copied from interface: ITreeItemWithID

Reorder the child items based on the item itself.

Specified by:

reorderChildrenByItems in interface ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aComparator - The comparator use. May not be null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object