org.mycore.frontend.basket.MCRBasket

All Implemented Interfaces:: Iterable<MCRBasketEntry>, Collection<MCRBasketEntry>, List<MCRBasketEntry>, Set<MCRBasketEntry>

public class MCRBasket extends Object implements List<MCRBasketEntry>, Set<MCRBasketEntry>

Implements a basket of entries. The basket has a type attribute that allows to distinguish multiple baskets within the same session. The basket implements the List and Set interfaces, it behaves like an ordered Set of entries. Entries already contained in the basket can not be re-added, each entry can be contained only once in the basket.

Author:: Frank Lützenkirchen

Constructor Summary

Constructors

Constructor

Description

MCRBasket(String type)

Creates a new basket of the given type.
Method Summary

Modifier and Type

Method

Description

void

add(int index, MCRBasketEntry entry)

boolean

add(MCRBasketEntry entry)

boolean

addAll(int index, Collection<? extends MCRBasketEntry> collection)

boolean

addAll(Collection<? extends MCRBasketEntry> collection)

void

clear()

boolean

contains(Object o)

boolean

containsAll(Collection<?> c)

void

down(MCRBasketEntry entry)

Moves the basket entry one position down in the list of basket entries.

MCRBasketEntry

get(int index)

MCRBasketEntry

get(String id)

Returns the basket entry with the given ID, or null.

String

getDerivateID()

Returns the ID of the derivate that holds the persistent data of this basket, or null

String

getType()

Returns the type of basket.

int

indexOf(Object o)

boolean

isEmpty()

Iterator<MCRBasketEntry>

iterator()

int

lastIndexOf(Object o)

ListIterator<MCRBasketEntry>

listIterator()

ListIterator<MCRBasketEntry>

listIterator(int index)

void

move(MCRBasketEntry entry, int change)

Moves a basket entry up or down in the list of basket entries.

MCRBasketEntry

remove(int index)

boolean

remove(Object o)

boolean

removeAll(Collection<?> c)

boolean

removeEntry(String id)

Removes the entry with the given ID from the basket.

void

resolveContent()

For all basket entries, if their XML content is not resolved yet, resolves the XML from the given URI in the entry.

boolean

retainAll(Collection<?> c)

MCRBasketEntry

set(int index, MCRBasketEntry entry)

void

setDerivateID(String derivateID)

Sets the ID of the derivate that holds the persistent data of this basket

int

size()

Spliterator<MCRBasketEntry>

spliterator()

List<MCRBasketEntry>

subList(int fromIndex, int toIndex)

Object[]

toArray()

<T> T[]

toArray(T[] a)

void

up(MCRBasketEntry entry)

Moves the basket entry one position up in the list of basket entries.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort

Methods inherited from interface java.util.Set
equals, hashCode

Constructor Details
- MCRBasket
  
  public MCRBasket(String type)
  
  Creates a new basket of the given type.
  
  Parameters:
  
  type - the type of basket, an attribute that can be used by the application to distinguish multiple basket within the same session.
Method Details
- getType
  
  public String getType()
  
  Returns the type of basket.
- getDerivateID
  
  public String getDerivateID()
  
  Returns the ID of the derivate that holds the persistent data of this basket, or null
- setDerivateID
  
  public void setDerivateID(String derivateID)
  
  Sets the ID of the derivate that holds the persistent data of this basket
- add
  
  public void add(int index, MCRBasketEntry entry)
  
  Specified by:
  
  add in interface List<MCRBasketEntry>
- add
  
  public boolean add(MCRBasketEntry entry)
  
  Specified by:
  
  add in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  add in interface List<MCRBasketEntry>
  
  Specified by:
  
  add in interface Set<MCRBasketEntry>
- addAll
  
  public boolean addAll(Collection<? extends MCRBasketEntry> collection)
  
  Specified by:
  
  addAll in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  addAll in interface List<MCRBasketEntry>
  
  Specified by:
  
  addAll in interface Set<MCRBasketEntry>
- addAll
  
  public boolean addAll(int index, Collection<? extends MCRBasketEntry> collection)
  
  Specified by:
  
  addAll in interface List<MCRBasketEntry>
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  clear in interface List<MCRBasketEntry>
  
  Specified by:
  
  clear in interface Set<MCRBasketEntry>
- contains
  
  public boolean contains(Object o)
  
  Specified by:
  
  contains in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  contains in interface List<MCRBasketEntry>
  
  Specified by:
  
  contains in interface Set<MCRBasketEntry>
- containsAll
  
  public boolean containsAll(Collection<?> c)
  
  Specified by:
  
  containsAll in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  containsAll in interface List<MCRBasketEntry>
  
  Specified by:
  
  containsAll in interface Set<MCRBasketEntry>
- get
  
  public MCRBasketEntry get(int index)
  
  Specified by:
  
  get in interface List<MCRBasketEntry>
- get
  
  public MCRBasketEntry get(String id)
  
  Returns the basket entry with the given ID, or null.
  
  Parameters:
  
  id - the ID of the basket entry.
- indexOf
  
  public int indexOf(Object o)
  
  Specified by:
  
  indexOf in interface List<MCRBasketEntry>
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  isEmpty in interface List<MCRBasketEntry>
  
  Specified by:
  
  isEmpty in interface Set<MCRBasketEntry>
- iterator
  
  public Iterator<MCRBasketEntry> iterator()
  
  Specified by:
  
  iterator in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  iterator in interface Iterable<MCRBasketEntry>
  
  Specified by:
  
  iterator in interface List<MCRBasketEntry>
  
  Specified by:
  
  iterator in interface Set<MCRBasketEntry>
- lastIndexOf
  
  public int lastIndexOf(Object o)
  
  Specified by:
  
  lastIndexOf in interface List<MCRBasketEntry>
- listIterator
  
  public ListIterator<MCRBasketEntry> listIterator()
  
  Specified by:
  
  listIterator in interface List<MCRBasketEntry>
- listIterator
  
  public ListIterator<MCRBasketEntry> listIterator(int index)
  
  Specified by:
  
  listIterator in interface List<MCRBasketEntry>
- remove
  
  public MCRBasketEntry remove(int index)
  
  Specified by:
  
  remove in interface List<MCRBasketEntry>
- remove
  
  public boolean remove(Object o)
  
  Specified by:
  
  remove in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  remove in interface List<MCRBasketEntry>
  
  Specified by:
  
  remove in interface Set<MCRBasketEntry>
- removeEntry
  
  public boolean removeEntry(String id)
  
  Removes the entry with the given ID from the basket.
  
  Returns:
  
  true, if the basket entry was removed successfully.
- removeAll
  
  public boolean removeAll(Collection<?> c)
  
  Specified by:
  
  removeAll in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  removeAll in interface List<MCRBasketEntry>
  
  Specified by:
  
  removeAll in interface Set<MCRBasketEntry>
- retainAll
  
  public boolean retainAll(Collection<?> c)
  
  Specified by:
  
  retainAll in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  retainAll in interface List<MCRBasketEntry>
  
  Specified by:
  
  retainAll in interface Set<MCRBasketEntry>
- set
  
  public MCRBasketEntry set(int index, MCRBasketEntry entry)
  
  Specified by:
  
  set in interface List<MCRBasketEntry>
- size
  
  public int size()
  
  Specified by:
  
  size in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  size in interface List<MCRBasketEntry>
  
  Specified by:
  
  size in interface Set<MCRBasketEntry>
- subList
  
  public List<MCRBasketEntry> subList(int fromIndex, int toIndex)
  
  Specified by:
  
  subList in interface List<MCRBasketEntry>
- toArray
  
  public Object[] toArray()
  
  Specified by:
  
  toArray in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  toArray in interface List<MCRBasketEntry>
  
  Specified by:
  
  toArray in interface Set<MCRBasketEntry>
- toArray
  
  public <T> T[] toArray(T[] a)
  
  Specified by:
  
  toArray in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  toArray in interface List<MCRBasketEntry>
  
  Specified by:
  
  toArray in interface Set<MCRBasketEntry>
- up
  
  public void up(MCRBasketEntry entry)
  
  Moves the basket entry one position up in the list of basket entries.
- down
  
  public void down(MCRBasketEntry entry)
  
  Moves the basket entry one position down in the list of basket entries.
- move
  
  public void move(MCRBasketEntry entry, int change)
  
  Moves a basket entry up or down in the list of basket entries.
  
  Parameters:
  
  change - the number of index positions to move the entry.
- resolveContent
  
  public void resolveContent()
  
  For all basket entries, if their XML content is not resolved yet, resolves the XML from the given URI in the entry.
- spliterator
  
  public Spliterator<MCRBasketEntry> spliterator()
  
  Specified by:
  
  spliterator in interface Collection<MCRBasketEntry>
  
  Specified by:
  
  spliterator in interface Iterable<MCRBasketEntry>
  
  Specified by:
  
  spliterator in interface List<MCRBasketEntry>
  
  Specified by:
  
  spliterator in interface Set<MCRBasketEntry>

Class MCRBasket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Set

Constructor Details

MCRBasket

Method Details

getType

getDerivateID

setDerivateID

add

add

addAll

addAll

clear

contains

containsAll

get

get

indexOf

isEmpty

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeEntry

removeAll

retainAll

set

size

subList

toArray

toArray

up

down

move

resolveContent

spliterator