Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.list

Class MetisListIndexed<T extends MetisDataItem.MetisDataIndexedItem>

java.lang.Object

io.github.tonywasher.joceanus.metis.list.MetisListIndexed<T>

Type Parameters:

T - the item type

All Implemented Interfaces:

MetisDataItem.MetisDataList<T>, MetisDataItem.MetisDataObjectFormat, MetisFieldItem

Direct Known Subclasses:

MetisListVersioned

public class MetisListIndexed<T extends MetisDataItem.MetisDataIndexedItem>
extends Object
implements MetisDataItem.MetisDataList<T>, MetisFieldItem

Indexed List.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldUpdatableItem, MetisFieldItem.MetisFieldVersionedDef

Constructor Summary

Constructors

Constructor	Description
MetisListIndexed()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(int pIndex, T pItem)	Add the item at index.
boolean	add(T pItem)	Add the item.
Integer	allocateNextId()	Allocate the next Id.
protected void	checkId(Integer pId)	Check the Id.
void	clear()	Clear the list.
boolean	containsId(Integer pId)	Is ID present in list?
boolean	containsItem(T pItem)	Determine whether an item is in the list.
Map<Integer,T>	copyIdMap()	Copy the idMap.
boolean	equals(Object pThat)
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
T	getAtIndex(int pIndex)	Obtain the item at the index.
Comparator<T>	getComparator()	Obtain the comparator.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
protected Map<Integer,T>	getIdMap()	Obtain the idMap.
T	getItemById(Integer pId)	Obtain item by Id.
Integer	getNextId()	Obtain the next Id.
List<T>	getUnderlyingList()	Obtain underlying list.
int	hashCode()
int	indexOfItem(T pItem)	Obtain the index of the item.
void	insertAtIndex(T pItem, int pIndex)	Insert the item at the index.
Iterator<T>	iterator()	Obtain the list iterator.
ListIterator<T>	listIterator()	Obtain a list iterator.
ListIterator<T>	listIterator(int pIndex)	Obtain the list iterator.
boolean	remove(Object pItem)	Remove the item.
T	removeAtIndex(int pIndex)	Remove the item at the index.
void	removeById(Integer pId)	Remove item from the list.
void	removeFromList(T pItem)	Remove item from the list.
Iterator<T>	reverseIterator()	Obtain a reverse list iterator.
void	setComparator(Comparator<T> pComparator)	Set the comparator.
void	sortList()	Sort the list.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataList

isEmpty, size

Constructor Details

MetisListIndexed

public MetisListIndexed()

Constructor.

Method Details

getDataFieldSet

public MetisFieldItem.MetisFieldSetDef getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

Returns:

the fieldSet

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

toString

public String toString()

Overrides:

toString in class Object

getIdMap

protected Map<Integer,T> getIdMap()

Obtain the idMap.

Returns:

the map

copyIdMap

public Map<Integer,T> copyIdMap()

Copy the idMap.

Returns:

the copy of the map

getUnderlyingList

public List<T> getUnderlyingList()

Description copied from interface: MetisDataItem.MetisDataList

Obtain underlying list.

Specified by:

getUnderlyingList in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

Returns:

the list

setComparator

public void setComparator(Comparator<T> pComparator)

Set the comparator.

Parameters:

pComparator - the comparator

getComparator

public Comparator<T> getComparator()

Obtain the comparator.

Returns:

the comparator

getNextId

public Integer getNextId()

Obtain the next Id.

Returns:

the next Id

allocateNextId

public Integer allocateNextId()

Allocate the next Id.

Returns:

the next allocated Id

add

public boolean add(T pItem)

Description copied from interface: MetisDataItem.MetisDataList

Add the item.

Specified by:

add in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

Parameters:

pItem - the item

Returns:

true/false - was item added?

add

public void add(int pIndex,
 T pItem)

Description copied from interface: MetisDataItem.MetisDataList

Add the item at index.

Specified by:

add in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

Parameters:

pIndex - the index

pItem - the item

removeFromList

public void removeFromList(T pItem)

Remove item from the list.

Parameters:

pItem - the item to remove

removeById

public void removeById(Integer pId)

Remove item from the list.

Parameters:

pId - the id of the item to remove

remove

public boolean remove(Object pItem)

Description copied from interface: MetisDataItem.MetisDataList

Remove the item.

Specified by:

remove in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

Parameters:

pItem - the item

Returns:

true/false - was item in list?

getItemById

public T getItemById(Integer pId)

Obtain item by Id.

Parameters:

pId - the id

Returns:

the item or null

containsItem

public boolean containsItem(T pItem)

Determine whether an item is in the list.

Parameters:

pItem - the item

Returns:

true/false

containsId

public boolean containsId(Integer pId)

Is ID present in list?

Parameters:

pId - the id to lookup

Returns:

true/false

clear

public void clear()

Description copied from interface: MetisDataItem.MetisDataList

Clear the list.

Specified by:

clear in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

indexOfItem

public int indexOfItem(T pItem)

Obtain the index of the item.

Parameters:

pItem - the item

Returns:

the index or -1 if not present

getAtIndex

public T getAtIndex(int pIndex)

Obtain the item at the index.

Parameters:

pIndex - the index of the item

Returns:

the item

removeAtIndex

public T removeAtIndex(int pIndex)

Remove the item at the index.

Parameters:

pIndex - the index of the item

Returns:

the item that was removed

insertAtIndex

public void insertAtIndex(T pItem,
 int pIndex)

Insert the item at the index.

Parameters:

pItem - the item to insert

pIndex - the index to insert at

iterator

public Iterator<T> iterator()

Description copied from interface: MetisDataItem.MetisDataList

Obtain the list iterator.

Specified by:

iterator in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

Returns:

the iterator

listIterator

public ListIterator<T> listIterator()

Obtain a list iterator.

Returns:

the iterator

reverseIterator

public Iterator<T> reverseIterator()

Obtain a reverse list iterator.

Returns:

the iterator

listIterator

public ListIterator<T> listIterator(int pIndex)

Description copied from interface: MetisDataItem.MetisDataList

Obtain the list iterator.

Specified by:

listIterator in interface MetisDataItem.MetisDataList<T extends MetisDataItem.MetisDataIndexedItem>

Parameters:

pIndex - the list position

Returns:

the iterator

sortList

public void sortList()

Sort the list.

checkId

protected void checkId(Integer pId)

Check the Id.

Parameters:

pId - the id

equals

public boolean equals(Object pThat)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object