org.xmcda

Class ReferenceableContainer<ELEMENT extends Referenceable>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<E>

java.util.LinkedHashSet<ELEMENT>

org.xmcda.ReferenceableContainer<ELEMENT>

Type Parameters:

ELEMENT - the type of the elements contained in this container.

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ELEMENT>, Collection<ELEMENT>, Set<ELEMENT>, CommonAttributes, HasDescription

Direct Known Subclasses:

Alternatives, AlternativesSets, Categories, CategoriesSets, Criteria, CriteriaSets

public abstract class ReferenceableContainer<ELEMENT extends Referenceable>
extends LinkedHashSet<ELEMENT>
implements CommonAttributes, HasDescription, Serializable

A set of Referenceable elements.

Author:

Sébastien Bigaret

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	getCreates

Constructor Summary

Constructors

Constructor and Description
ReferenceableContainer()

Method Summary

Modifier and Type	Method and Description
boolean	add(ELEMENT e)
boolean	addAll(Collection<? extends ELEMENT> elementsCollection)
boolean	contains(String id) Returns true if this container has an element with the specified id
abstract Class<ELEMENT>	elementClass()
ELEMENT	get(String id)
ELEMENT	get(String id, boolean create) Returns the existing element stored in the container with the specified id, or if there is no such element, creates it if create is true, otherwise returns null.
Description	getDescription()
ArrayList<String>	getIDs() Returns the ids of the elements in the container.
ArrayList<String>	getNames() Returns the names of the elements in the container.
String	id()
boolean	isVoid()
Iterator<ELEMENT>	iterator()
String	mcdaConcept()
void	merge(ELEMENT element) Adds the specified element to the container if there is no element with the same id, or merges the specified element into the existing one.
String	name()
boolean	remove(Object o)
boolean	removeAll(Collection<?> collection)
void	setDescription(Description description)
void	setId(String id)
void	setMcdaConcept(String mcdaConcept)
void	setName(String name)

Methods inherited from class java.util.LinkedHashSet

spliterator

Methods inherited from class java.util.HashSet

clear, clone, contains, isEmpty, size

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

clear, contains, containsAll, equals, hashCode, isEmpty, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

getCreates

public boolean getCreates

Constructor Detail

ReferenceableContainer

public ReferenceableContainer()

Method Detail

elementClass

public abstract Class<ELEMENT> elementClass()

get

public ELEMENT get(String id)

get

public ELEMENT get(String id,
                   boolean create)

Returns the existing element stored in the container with the specified id, or if there is no such element, creates it if create is true, otherwise returns null.

Parameters:

id - the id of the element to be searched in the container

create - determines whether an element with the specified id should be created and returned if it does not already exist.

Returns:

the searched element, or {code null} if the container has no such element and create is false.

getIDs

public ArrayList<String> getIDs()

Returns the ids of the elements in the container.

Returns:

the ids of the elements in the container.

getNames

public ArrayList<String> getNames()

Returns the names of the elements in the container.

Returns:

the names of the elements in the container.

contains

public boolean contains(String id)

Returns true if this container has an element with the specified id

Parameters:

id - the id of the element to search within the container

Returns:

true if this container has an element with the specified id

merge

public void merge(ELEMENT element)

Adds the specified element to the container if there is no element with the same id, or merges the specified element into the existing one.

Parameters:

element - the element whose content should be put within the container.

See Also:

Referenceable.merge(Referenceable)

isVoid

public boolean isVoid()

add

public boolean add(ELEMENT e)

Specified by:

add in interface Collection<ELEMENT extends Referenceable>

Specified by:

add in interface Set<ELEMENT extends Referenceable>

Overrides:

add in class HashSet<ELEMENT extends Referenceable>

addAll

public boolean addAll(Collection<? extends ELEMENT> elementsCollection)

Specified by:

addAll in interface Collection<ELEMENT extends Referenceable>

Specified by:

addAll in interface Set<ELEMENT extends Referenceable>

Overrides:

addAll in class AbstractCollection<ELEMENT extends Referenceable>

iterator

public Iterator<ELEMENT> iterator()

Specified by:

iterator in interface Iterable<ELEMENT extends Referenceable>

Specified by:

iterator in interface Collection<ELEMENT extends Referenceable>

Specified by:

iterator in interface Set<ELEMENT extends Referenceable>

Overrides:

iterator in class HashSet<ELEMENT extends Referenceable>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<ELEMENT extends Referenceable>

Specified by:

remove in interface Set<ELEMENT extends Referenceable>

Overrides:

remove in class HashSet<ELEMENT extends Referenceable>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<ELEMENT extends Referenceable>

Specified by:

removeAll in interface Set<ELEMENT extends Referenceable>

Overrides:

removeAll in class AbstractSet<ELEMENT extends Referenceable>

id

public String id()

Specified by:

id in interface CommonAttributes

setId

public void setId(String id)

Specified by:

setId in interface CommonAttributes

name

public String name()

Specified by:

name in interface CommonAttributes

mcdaConcept

public String mcdaConcept()

Specified by:

mcdaConcept in interface CommonAttributes

setName

public void setName(String name)

Specified by:

setName in interface CommonAttributes

setMcdaConcept

public void setMcdaConcept(String mcdaConcept)

Specified by:

setMcdaConcept in interface CommonAttributes

setDescription

public void setDescription(Description description)

Specified by:

setDescription in interface HasDescription

getDescription

public Description getDescription()

Specified by:

getDescription in interface HasDescription