fr.lirmm.graphik.graal.core.atomset

Class LinkedListAtomSet

java.lang.Object

fr.lirmm.graphik.graal.core.atomset.AbstractAtomSet

fr.lirmm.graphik.graal.core.atomset.AbstractInMemoryAtomSet

fr.lirmm.graphik.graal.core.atomset.LinkedListAtomSet

All Implemented Interfaces:

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

public class LinkedListAtomSet
extends AbstractInMemoryAtomSet
implements InMemoryAtomSet

Author:

Clément Sipieter (INRIA)

Constructor Summary

Constructors

Constructor and Description
LinkedListAtomSet()
LinkedListAtomSet(Atom... atoms)
LinkedListAtomSet(AtomSet atomset) copy constructor
LinkedListAtomSet(CloseableIterator<Atom> it)
LinkedListAtomSet(CloseableIteratorWithoutException<Atom> it)
LinkedListAtomSet(InMemoryAtomSet atomset) copy constructor
LinkedListAtomSet(LinkedList<Atom> list)

Method Summary

Modifier and Type	Method and Description
boolean	add(Atom atom) Add the specified atom to this atom set if is not already present.
CloseableIteratorWithoutException<Atom>	atomsByPredicate(Predicate p) Returns an iterator over all atoms with the specified predicate.
void	clear()
ConstantGenerator	getFreshSymbolGenerator()
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.
boolean	isEmpty()
CloseableIteratorWithoutException<Atom>	iterator() Returns an iterator over the atoms in this atom set.
CloseableIteratorWithoutException<Atom>	match(Atom atom) Returns an iterator over atoms that match predicate and constants from the specified atom.
CloseableIteratorWithoutException<Predicate>	predicatesIterator() Returns an iterator over all predicates in this atom set.
boolean	remove(Atom atom) Remove the specified atom from this this atom set.
int	size()
CloseableIteratorWithoutException<Term>	termsByPredicatePosition(Predicate p, int position) Returns an iterator over terms which are in a specific position in at least one atom with the specified predicate.
CloseableIteratorWithoutException<Term>	termsIterator() Returns an iterator over all terms in this atom set.
CloseableIteratorWithoutException<Term>	termsIterator(Term.Type type) Deprecated.

Methods inherited from class fr.lirmm.graphik.graal.core.atomset.AbstractInMemoryAtomSet

addAll, addAll, constantsIterator, contains, getConstants, getLiterals, getVariables, isSubSetOf, literalsIterator, removeAll, removeAll, variablesIterator

Methods inherited from class fr.lirmm.graphik.graal.core.atomset.AbstractAtomSet

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.lirmm.graphik.graal.api.core.InMemoryAtomSet

addAll, addAll, constantsIterator, contains, getConstants, getLiterals, getVariables, isSubSetOf, literalsIterator, removeAll, removeAll, variablesIterator

Methods inherited from interface fr.lirmm.graphik.graal.api.core.AtomSet

addAll, addAll, removeAll, removeAll

Constructor Detail

LinkedListAtomSet

public LinkedListAtomSet()

LinkedListAtomSet

public LinkedListAtomSet(LinkedList<Atom> list)

LinkedListAtomSet

public LinkedListAtomSet(Atom... atoms)

LinkedListAtomSet

public LinkedListAtomSet(CloseableIterator<Atom> it)
                  throws IteratorException

Throws:

IteratorException

LinkedListAtomSet

public LinkedListAtomSet(CloseableIteratorWithoutException<Atom> it)

LinkedListAtomSet

public LinkedListAtomSet(AtomSet atomset)
                  throws IteratorException

copy constructor

Throws:

IteratorException

LinkedListAtomSet

public LinkedListAtomSet(InMemoryAtomSet atomset)

copy constructor

Method Detail

match

public CloseableIteratorWithoutException<Atom> match(Atom atom)

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

Specified by:

match in interface InMemoryAtomSet

Returns:

an iterator over atoms.

atomsByPredicate

public CloseableIteratorWithoutException<Atom> atomsByPredicate(Predicate p)

Description copied from interface: AtomSet

Returns an iterator over all atoms with the specified predicate.

Specified by:

atomsByPredicate in interface AtomSet

Specified by:

atomsByPredicate in interface InMemoryAtomSet

Returns:

an iterator over all atoms with the specified predicate.

termsByPredicatePosition

public CloseableIteratorWithoutException<Term> termsByPredicatePosition(Predicate p,
                                                                        int position)

Description copied from interface: AtomSet

Returns an iterator over terms which are in a specific position in at least one atom with the specified predicate.

Specified by:

termsByPredicatePosition in interface AtomSet

Specified by:

termsByPredicatePosition in interface InMemoryAtomSet

position - the term position in atoms, positions starts from 0.

Returns:

an iterator over terms which appear in the specified position of the specified predicate.

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 AbstractInMemoryAtomSet

Returns:

a Set of all predicates.

predicatesIterator

public CloseableIteratorWithoutException<Predicate> predicatesIterator()

Description copied from interface: AtomSet

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

Specified by:

predicatesIterator in interface AtomSet

Specified by:

predicatesIterator in interface InMemoryAtomSet

Returns:

an iterator over all predicates.

add

public boolean add(Atom atom)

Description copied from interface: AtomSet

Add the specified atom to this atom set if is not already present.

Specified by:

add in interface AtomSet

Specified by:

add in interface InMemoryAtomSet

Parameters:

atom - - atom to be added to this atom set

Returns:

true if this atom set did not already contain the specified atom

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 AbstractInMemoryAtomSet

Returns:

a Set of all terms.

getFreshSymbolGenerator

public ConstantGenerator getFreshSymbolGenerator()

Specified by:

getFreshSymbolGenerator in interface AtomSet

Returns:

the SymbolGenerator used by this atomset.

termsIterator

public CloseableIteratorWithoutException<Term> termsIterator()

Description copied from interface: AtomSet

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

Specified by:

termsIterator in interface AtomSet

Specified by:

termsIterator in interface InMemoryAtomSet

Returns:

an iterator over all terms.

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 AbstractInMemoryAtomSet

Returns:

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

termsIterator

@Deprecated
public CloseableIteratorWithoutException<Term> termsIterator(Term.Type type)

Deprecated.

Description copied from interface: AtomSet

This method is deprecated since 1.3, use AtomSet.variablesIterator(), AtomSet.constantsIterator() or AtomSet.literalsIterator() instead.

Returns an iterator of all terms of the specified type in this atom set. Each term is iterated only once time.

Specified by:

termsIterator in interface AtomSet

Specified by:

termsIterator in interface InMemoryAtomSet

Returns:

an iterator of all terms.

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

Parameters:

atom - - the atom to be removed

Returns:

true if this atom set contained the specified atom.

iterator

public CloseableIteratorWithoutException<Atom> iterator()

Description copied from interface: AtomSet

Returns an iterator over the atoms in this atom set.

Specified by:

iterator in interface AtomSet

Specified by:

iterator in interface InMemoryAtomSet

Specified by:

iterator in interface CloseableIterable<Atom>

Specified by:

iterator in interface CloseableIterableWithoutException<Atom>

Returns:

an iterator over the atoms in this atom set.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface AtomSet

Specified by:

isEmpty in interface InMemoryAtomSet

Overrides:

isEmpty in class AbstractInMemoryAtomSet

Returns:

true if this atom set is empty, false otherwise.

size

public int size()

clear

public void clear()

Specified by:

clear in interface AtomSet

Specified by:

clear in interface InMemoryAtomSet