Class AbstractInMemoryAtomSet

java.lang.Object

fr.lirmm.graphik.integraal.core.atomset.AbstractAtomSet

fr.lirmm.graphik.integraal.core.atomset.AbstractInMemoryAtomSet

All Implemented Interfaces:

AtomSet, InMemoryAtomSet, CloseableIterable<Atom>, CloseableIterableWithoutException<Atom>, Iterable<Atom>

Direct Known Subclasses:

DefaultInMemoryAtomSet, LinkedListAtomSet

public abstract class AbstractInMemoryAtomSet
extends AbstractAtomSet
implements InMemoryAtomSet

Base implementation for in-memory atom sets.

Author:

Clément Sipieter (INRIA) <clement@6pi.fr>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractInMemoryAtomSet()	Creates an abstract in-memory atom set base implementation.

Method Summary

Modifier and Type	Method	Description
boolean	addAll(InMemoryAtomSet atoms)	Adds all atoms from the specified in-memory atom set.
boolean	addAll(CloseableIteratorWithoutException<? extends Atom> atoms)	Adds all atoms produced by the specified iterator.
CloseableIteratorWithoutException<Constant>	constantsIterator()	Returns an iterator over all constants in this atom set.
boolean	contains(Atom atom)	Returns true if this atom set contains the specified atom.
Set<Constant>	getConstants()	Returns a Set of all constants in this atom set.
Set<Literal>	getLiterals()	Returns a Set of all literals in this atom set.
Set<Predicate>	getPredicates()	Returns a Set of all predicates in this atom set.
Set<Term>	getTerms()	Returns a Set of all terms in this atom set.
Set<Term>	getTerms(Term.Type type)	Deprecated.
Set<Variable>	getVariables()	Returns a Set of all variables in this atom set.
boolean	isEmpty()	Returns whether this atom set contains no atom.
boolean	isSubSetOf(AtomSet atomset)	Deprecated.
CloseableIteratorWithoutException<Literal>	literalsIterator()	Returns an iterator over all literals in this atom set.
CloseableIterator<Atom>	match(Atom atom)	Returns an iterator over atoms that match predicate and constants from the specified atom.
boolean	remove(Atom atom)	Remove the specified atom from this this atom set.
boolean	removeAll(InMemoryAtomSet atoms)	Removes all atoms contained in the specified atom set.
boolean	removeAll(CloseableIteratorWithoutException<? extends Atom> atoms)	Removes all atoms provided by the specified iterator.
int	size()	This default implementation should be overriden, it is convenient for in memory set, but will be inefficient in some case.
Atom[]	toArray()	Copies the atoms of this set into an array.
CloseableIteratorWithoutException<Variable>	variablesIterator()	Returns an iterator over all variables in this atom set.

Methods inherited from class AbstractAtomSet

addAll, addAll, equals, equals, removeAll, removeAll, toString

Methods inherited from class Object

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

Methods inherited from interface AtomSet

addAll, addAll, atomsByTerm, containsTerm, getFreshSymbolGenerator, removeAll, removeAll

Methods inherited from interface InMemoryAtomSet

add, atomsByPredicate, clear, iterator, match, parallelStream, predicatesIterator, removeWithoutCheck, spliterator, stream, termsByPredicatePosition, termsIterator, termsIterator

Methods inherited from interface Iterable

forEach

Constructor Details

AbstractInMemoryAtomSet

protected AbstractInMemoryAtomSet()

Creates an abstract in-memory atom set base implementation.

Method Details

contains

public boolean contains(Atom atom)

Description copied from interface: AtomSet

Returns true if this atom set contains the specified atom.

Specified by:

contains in interface AtomSet

Specified by:

contains in interface InMemoryAtomSet

Overrides:

contains in class AbstractAtomSet

Parameters:

atom - the atom to search for

Returns:

true if this atom set contains the specified atom.

addAll

public boolean addAll(CloseableIteratorWithoutException<? extends Atom> atoms)

Description copied from interface: InMemoryAtomSet

Adds all atoms produced by the specified iterator.

Specified by:

addAll in interface InMemoryAtomSet

Parameters:

atoms - the atoms to add

Returns:

true if this set changed as a result of the call

addAll

public boolean addAll(InMemoryAtomSet atoms)

Description copied from interface: InMemoryAtomSet

Adds all atoms from the specified in-memory atom set.

Specified by:

addAll in interface InMemoryAtomSet

Parameters:

atoms - the atoms to add

Returns:

true if this set changed as a result of the call

remove

public boolean remove(Atom atom)

Description copied from interface: AtomSet

Remove the specified atom from this this atom set.

Specified by:

remove in interface AtomSet

Specified by:

remove in interface InMemoryAtomSet

Overrides:

remove in class AbstractAtomSet

Parameters:

atom - the atom to be removed

Returns:

true if this atom set contained the specified atom.

removeAll

public boolean removeAll(CloseableIteratorWithoutException<? extends Atom> atoms)

Description copied from interface: InMemoryAtomSet

Removes all atoms provided by the specified iterator.

Specified by:

removeAll in interface InMemoryAtomSet

Parameters:

atoms - the atoms to remove

Returns:

true if this set changed as a result of the call

removeAll

public boolean removeAll(InMemoryAtomSet atoms)

Description copied from interface: InMemoryAtomSet

Removes all atoms contained in the specified atom set.

Specified by:

removeAll in interface InMemoryAtomSet

Parameters:

atoms - the atoms to remove

Returns:

true if this set changed as a result of the call

match

public CloseableIterator<Atom> match(Atom atom)
                              throws AtomSetException

Description copied from interface: AtomSet

Returns an iterator over atoms that match predicate and constants from the specified atom.

Specified by:

match in interface AtomSet

Overrides:

match in class AbstractAtomSet

Parameters:

atom - the atom pattern to match

Returns:

an iterator over atoms.

Throws:

AtomSetException - if the match operation fails

getTerms

public Set<Term> getTerms()

Description copied from interface: AtomSet

Returns a Set of all terms in this atom set.

Specified by:

getTerms in interface AtomSet

Specified by:

getTerms in interface InMemoryAtomSet

Overrides:

getTerms in class AbstractAtomSet

Returns:

a Set of all terms.

getVariables

public Set<Variable> getVariables()

Description copied from interface: AtomSet

Returns a Set of all variables in this atom set.

Specified by:

getVariables in interface AtomSet

Specified by:

getVariables in interface InMemoryAtomSet

Overrides:

getVariables in class AbstractAtomSet

Returns:

a Set of all variables.

getConstants

public Set<Constant> getConstants()

Description copied from interface: AtomSet

Returns a Set of all constants in this atom set.

Specified by:

getConstants in interface AtomSet

Specified by:

getConstants in interface InMemoryAtomSet

Overrides:

getConstants in class AbstractAtomSet

Returns:

a Set of all constants.

getLiterals

public Set<Literal> getLiterals()

Description copied from interface: AtomSet

Returns a Set of all literals in this atom set.

Specified by:

getLiterals in interface AtomSet

Specified by:

getLiterals in interface InMemoryAtomSet

Overrides:

getLiterals in class AbstractAtomSet

Returns:

a Set of all literals.

getTerms

@Deprecated
public Set<Term> getTerms(Term.Type type)

Deprecated.

Description copied from interface: AtomSet

This method is deprecated since 1.3, use AtomSet.getVariables(), AtomSet.getConstants() or AtomSet.getLiterals() instead.

Returns a Set of all terms of the specified type in this atom set.

Specified by:

getTerms in interface AtomSet

Specified by:

getTerms in interface InMemoryAtomSet

Overrides:

getTerms in class AbstractAtomSet

Parameters:

type - the term type to filter on

Returns:

a collection of all terms of the specified type in this atom set.

variablesIterator

public CloseableIteratorWithoutException<Variable> variablesIterator()

Description copied from interface: AtomSet

Returns an iterator over all variables in this atom set. Each term is iterated only once time.

Specified by:

variablesIterator in interface AtomSet

Specified by:

variablesIterator in interface InMemoryAtomSet

Overrides:

variablesIterator in class AbstractAtomSet

Returns:

an iterator over all variables.

constantsIterator

public CloseableIteratorWithoutException<Constant> constantsIterator()

Description copied from interface: AtomSet

Returns an iterator over all constants in this atom set. Each term is iterated only once time.

Specified by:

constantsIterator in interface AtomSet

Specified by:

constantsIterator in interface InMemoryAtomSet

Overrides:

constantsIterator in class AbstractAtomSet

Returns:

an iterator over all constants.

literalsIterator

public CloseableIteratorWithoutException<Literal> literalsIterator()

Description copied from interface: AtomSet

Returns an iterator over all literals in this atom set. Each term is iterated only once time.

Specified by:

literalsIterator in interface AtomSet

Specified by:

literalsIterator in interface InMemoryAtomSet

Overrides:

literalsIterator in class AbstractAtomSet

Returns:

an iterator over all literals.

getPredicates

public Set<Predicate> getPredicates()

Description copied from interface: AtomSet

Returns a Set of all predicates in this atom set.

Specified by:

getPredicates in interface AtomSet

Specified by:

getPredicates in interface InMemoryAtomSet

Overrides:

getPredicates in class AbstractAtomSet

Returns:

a Set of all predicates.

isSubSetOf

@Deprecated
public boolean isSubSetOf(AtomSet atomset)

Deprecated.

Description copied from interface: AtomSet

Use AtomSets.contains instead. Check if all atoms of this AtomSet are also contained in the specified AtomSet.

Specified by:

isSubSetOf in interface AtomSet

Specified by:

isSubSetOf in interface InMemoryAtomSet

Overrides:

isSubSetOf in class AbstractAtomSet

Parameters:

atomset - the candidate superset

Returns:

true if all atoms of this AtomSet are also contained in the specified atomset, false otherwise.

isEmpty

public boolean isEmpty()

Description copied from interface: AtomSet

Returns whether this atom set contains no atom.

Specified by:

isEmpty in interface AtomSet

Specified by:

isEmpty in interface InMemoryAtomSet

Overrides:

isEmpty in class AbstractAtomSet

Returns:

true if this atom set is empty, false otherwise.

toArray

public Atom[] toArray()

Description copied from interface: InMemoryAtomSet

Copies the atoms of this set into an array.

Specified by:

toArray in interface InMemoryAtomSet

Returns:

the atoms contained in this set

size

public int size()

Description copied from class: AbstractAtomSet

This default implementation should be overriden, it is convenient for in memory set, but will be inefficient in some case.

Specified by:

size in interface AtomSet

Specified by:

size in interface InMemoryAtomSet

Overrides:

size in class AbstractAtomSet

Returns:

the number of atoms in the set

See Also:

• AtomSet.size()