Package edu.upc.fib.inlab.imp.kse.logics.logicschema.domain

Class ImmutableLiteralsList

java.lang.Object

edu.upc.fib.inlab.imp.kse.logics.logicschema.domain.ImmutableLiteralsList

All Implemented Interfaces:

Iterable<Literal>, Collection<Literal>, List<Literal>

public class ImmutableLiteralsList
extends Object
implements List<Literal>

An immutable list of literals.
When the immutable list has been created through an unfolding, or applying a substitution, it remembers which literals has been replaced with which other literals

Constructor Summary

Constructors

Constructor	Description
ImmutableLiteralsList(Literal... literal)
ImmutableLiteralsList(List<Literal> literalList)

Method Summary

Modifier and Type	Method	Description
<T> T	accept(LogicSchemaVisitor<T> visitor)
void	add(int index, Literal element)	Deprecated. Unsupported operation.
boolean	add(Literal literal)	Deprecated. Unsupported operation.
boolean	addAll(int index, Collection<? extends Literal> c)	Deprecated. Unsupported operation.
boolean	addAll(Collection<? extends Literal> c)	Deprecated. Unsupported operation.
ImmutableLiteralsList	applySubstitution(Substitution substitution)
void	clear()	Deprecated. Unsupported operation.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
Literal	get(int index)
Set<LiteralPosition>	getLiteralPositionWithVariable(Variable variable)
Optional<Literal>	getOriginalLiteral(Literal currentLiteral)
Optional<LiteralPosition>	getOriginalLiteralPosition(Literal currentLiteral, int termIndex)
Set<PredicatePosition>	getPredicatePositionsWithVar(Variable variable)
Set<Variable>	getUsedVariables()
Set<Variable>	getVariablesInBuiltInLiterals()
Set<Variable>	getVariablesInNegativeOrdinaryLiterals()
Set<Variable>	getVariablesInPositiveOrdinaryLiterals()
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<Literal>	iterator()
int	lastIndexOf(Object o)
ListIterator<Literal>	listIterator()
ListIterator<Literal>	listIterator(int index)
Literal	remove(int index)	Deprecated. Unsupported operation.
boolean	remove(Object o)	Deprecated. Unsupported operation.
boolean	removeAll(Collection<?> c)	Deprecated. Unsupported operation.
boolean	retainAll(Collection<?> c)	Deprecated. Unsupported operation.
Literal	set(int index, Literal element)	Deprecated. Unsupported operation.
int	size()
ImmutableLiteralsList	sortLiterals(Comparator<Literal> literalComparator)	Sort literals according to literalComparator
ImmutableLiteralsList	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()
List<ImmutableLiteralsList>	unfold(int index)	Unfolding a literal returns a list of literals' list, one for each derivation rule of this literal.
List<ImmutableLiteralsList>	unfold(int index, boolean unfoldNegatedLiterals)
List<ImmutableLiteralsList>	unfoldRecursively()
List<ImmutableLiteralsList>	unfoldWithNegationExtension(int index)	This is an extension of the unfold method that also applies an unfolding for negated literals whose derivation rules does not contain existential variables.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

replaceAll, sort, spliterator

Constructor Details

ImmutableLiteralsList

public ImmutableLiteralsList(Literal... literal)

ImmutableLiteralsList

public ImmutableLiteralsList(List<Literal> literalList)

Method Details

getPredicatePositionsWithVar

public Set<PredicatePosition> getPredicatePositionsWithVar(Variable variable)

Parameters:

variable - not null

Returns:

a set of PredicatePositions appearing in literals that contains the given variable

getLiteralPositionWithVariable

public Set<LiteralPosition> getLiteralPositionWithVariable(Variable variable)

Parameters:

variable - not null

Returns:

a set of LiteralPositions appearing in literals that contains the given variable

sortLiterals

public ImmutableLiteralsList sortLiterals(Comparator<Literal> literalComparator)

Sort literals according to literalComparator

Returns:

a new sorted list of literals

getVariablesInPositiveOrdinaryLiterals

public Set<Variable> getVariablesInPositiveOrdinaryLiterals()

getVariablesInNegativeOrdinaryLiterals

public Set<Variable> getVariablesInNegativeOrdinaryLiterals()

getVariablesInBuiltInLiterals

public Set<Variable> getVariablesInBuiltInLiterals()

unfoldRecursively

public List<ImmutableLiteralsList> unfoldRecursively()

Returns:

a list of ImmutableLiteralsList after recursively unfolding all the positive derived non-recursive literals, or itself if no unfolding can be applied

unfold

public List<ImmutableLiteralsList> unfold(int index)

Unfolding a literal returns a list of literals' list, one for each derivation rule of this literal. In particular, for each derivation rule, it returns a literals' list replacing the variables of the derivation rule's head for the terms appearing in this literal.

For instance, if we have the literal list "P(1), Q(z)", with derivation rules "P(x) :- R(x), S(x)" and "P(y) :- T(y), U(y)", unfolding the first literal of "P(1), Q(z)" will return two literals' list: "R(1), S(1), Q(z)" and "T(1), U(1), Q(z)".

This unfolding avoids clashing the variables inside the derivation rule's body with the variables appearing in this literal. For instance, if we have the list "P(a, b), Q(z)" with a derivation rule "P(x, y) :- R(x, y, a, b, z)", and we unfold the first literal it will return "R(a, b, a', b', z'), Q(z)"

If the literal proposed to be unfolded, is base, or it is negated, or it is built in, it returns the very same literals' list.

Returns:

a list of ImmutableLiteralsList representing the result of unfolding the index-th literal

unfold

public List<ImmutableLiteralsList> unfold(int index,
 boolean unfoldNegatedLiterals)

applySubstitution

public ImmutableLiteralsList applySubstitution(Substitution substitution)

size

public int size()

Specified by:

size in interface Collection<Literal>

Specified by:

size in interface List<Literal>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Literal>

Specified by:

isEmpty in interface List<Literal>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Literal>

Specified by:

contains in interface List<Literal>

iterator

public Iterator<Literal> iterator()

Specified by:

iterator in interface Collection<Literal>

Specified by:

iterator in interface Iterable<Literal>

Specified by:

iterator in interface List<Literal>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<Literal>

Specified by:

toArray in interface List<Literal>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<Literal>

Specified by:

toArray in interface List<Literal>

add

@Deprecated(forRemoval=false)
public boolean add(Literal literal)

Deprecated.

Unsupported operation.

Specified by:

add in interface Collection<Literal>

Specified by:

add in interface List<Literal>

remove

@Deprecated(forRemoval=false)
public boolean remove(Object o)

Deprecated.

Unsupported operation.

Specified by:

remove in interface Collection<Literal>

Specified by:

remove in interface List<Literal>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<Literal>

Specified by:

containsAll in interface List<Literal>

addAll

@Deprecated(forRemoval=false)
public boolean addAll(Collection<? extends Literal> c)

Deprecated.

Unsupported operation.

Specified by:

addAll in interface Collection<Literal>

Specified by:

addAll in interface List<Literal>

addAll

@Deprecated(forRemoval=false)
public boolean addAll(int index,
 Collection<? extends Literal> c)

Deprecated.

Unsupported operation.

Specified by:

addAll in interface List<Literal>

removeAll

@Deprecated(forRemoval=false)
public boolean removeAll(Collection<?> c)

Deprecated.

Unsupported operation.

Specified by:

removeAll in interface Collection<Literal>

Specified by:

removeAll in interface List<Literal>

retainAll

@Deprecated(forRemoval=false)
public boolean retainAll(Collection<?> c)

Deprecated.

Unsupported operation.

Specified by:

retainAll in interface Collection<Literal>

Specified by:

retainAll in interface List<Literal>

clear

@Deprecated(forRemoval=false)
public void clear()

Deprecated.

Unsupported operation.

Specified by:

clear in interface Collection<Literal>

Specified by:

clear in interface List<Literal>

get

public Literal get(int index)

Specified by:

get in interface List<Literal>

set

@Deprecated(forRemoval=false)
public Literal set(int index,
 Literal element)

Deprecated.

Unsupported operation.

Specified by:

set in interface List<Literal>

add

@Deprecated(forRemoval=false)
public void add(int index,
 Literal element)

Deprecated.

Unsupported operation.

Specified by:

add in interface List<Literal>

remove

@Deprecated(forRemoval=false)
public Literal remove(int index)

Deprecated.

Unsupported operation.

Specified by:

remove in interface List<Literal>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<Literal>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<Literal>

listIterator

public ListIterator<Literal> listIterator()

Specified by:

listIterator in interface List<Literal>

listIterator

public ListIterator<Literal> listIterator(int index)

Specified by:

listIterator in interface List<Literal>

subList

public ImmutableLiteralsList subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<Literal>

getUsedVariables

public Set<Variable> getUsedVariables()

unfoldWithNegationExtension

public List<ImmutableLiteralsList> unfoldWithNegationExtension(int index)

This is an extension of the unfold method that also applies an unfolding for negated literals whose derivation rules does not contain existential variables. E.g.: Suppose the literals list "P(x), not(Derived(x))" with derivation rule "Derived(x) :- A(x), not(B(x))"

Unfolding not(Derived()) in such literals list will return two literals list: "P(x), not(A(x))" and "P(x), B(x)".

Returns:

a list of ImmutableLiteralsList representing the result of unfolding the index-th literal

getOriginalLiteral

public Optional<Literal> getOriginalLiteral(Literal currentLiteral)

Parameters:

currentLiteral - not null

Returns:

the literal that has created the given literal through an unfolding, or through applying a substitution to a previous ImmutableLiteralsList.

getOriginalLiteralPosition

public Optional<LiteralPosition> getOriginalLiteralPosition(Literal currentLiteral,
 int termIndex)

accept

public <T> T accept(LogicSchemaVisitor<T> visitor)

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Literal>

Specified by:

hashCode in interface List<Literal>

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Literal>

Specified by:

equals in interface List<Literal>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object