Package de.monochromata.anaphors.ast

Interface ASTBasedAnaphora<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

Type Parameters:

N - The node type in the AST

E - The expression type

T - The type type

B - The binding type

TB - The type binding type

S - The scope type (optional)

I - The type used to represent identifiers

QI - The type used to represent qualified identifiers

R - The sub-type of related expression to use

A - The sub-type of AST-based anaphora to use

All Superinterfaces:

AnaphorPart<N,E,T,B,TB,S,I,QI,R,A>, RelatedExpressionPart<N,E,T,B,TB,S,I,QI,R>

All Known Subinterfaces:

DirectAnaphora<N,E,T,B,TB,S,I,QI,R,A>, IndirectAnaphora<N,E,T,B,TB,S,I,QI,R,A>

All Known Implementing Classes:

AbstractASTBasedAnaphora, DefaultDirectAnaphora, DefaultIndirectAnaphora

public interface ASTBasedAnaphora<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>
extends RelatedExpressionPart<N,E,T,B,TB,S,I,QI,R>, AnaphorPart<N,E,T,B,TB,S,I,QI,R,A>

The relation between anaphor and related expression. Because instances of this type contain AST nodes, they should be short-lived and must not be persisted.

Method Summary

Modifier and Type	Method	Description
default String	getAnaphor()
default E	getAnaphorExpression()	Get the expression that acts as anaphor.
AnaphorPart<N,E,T,B,TB,S,I,QI,R,A>	getAnaphorPart()
default AnaphorResolutionStrategy<N,E,T,B,TB,S,I,QI,R,A>	getAnaphorResolutionStrategy()	Get the anaphor resolution strategy that was used to find the referent of the anaphor involved in this anaphora relation.
default B	getBinding()
default String	getKind()	Returns an identifier of the kind of anaphora relationship in the format <relatedExpressionStrategy>-<anaphorResolutionStrategy>-<referentializationStrategy>
String	getReferenceDescription()	Returns a description of the anaphora relation, to enable users to distinguish multiple anaphora relations that are referentially ambiguous.
default Referent<TB,S,I,QI>	getReferent()	Get the referent of the anaphor.
default ReferentializationStrategy<E,TB,S,I,QI>	getReferentializationStrategy()
default R	getRelatedExpression()	Get the related expression of the anaphora relation.
RelatedExpressionPart<N,E,T,B,TB,S,I,QI,R>	getRelatedExpressionPart()
default RelatedExpressionStrategy<N,T,B,TB,S,QI,R>	getRelatedExpressionStrategy()	Get the related expression strategy that was used to find the related expression of this anaphora relation.
boolean	isExplicated()	Deprecated. The state of an anaphor should be represented internally in an implementation-specific way.
boolean	isUnderspecified()	Deprecated. The state of an anaphor should be represented internally in an implementation-specific way.
default TB	resolveType(S scope)

Method Details

getKind

default String getKind()

Returns an identifier of the kind of anaphora relationship in the format <relatedExpressionStrategy>-<anaphorResolutionStrategy>-<referentializationStrategy>

Returns:

An identifier of the kind of anaphora relationship

See Also:

Strategy.getKind(), Strategy.getKind(), Strategy.getKind()

getRelatedExpressionPart

RelatedExpressionPart<N,E,T,B,TB,S,I,QI,R> getRelatedExpressionPart()

getAnaphorPart

AnaphorPart<N,E,T,B,TB,S,I,QI,R,A> getAnaphorPart()

getRelatedExpression

default R getRelatedExpression()

Description copied from interface: RelatedExpressionPart

Get the related expression of the anaphora relation.

Specified by:

getRelatedExpression in interface RelatedExpressionPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>>

Returns:

The related expression.

getRelatedExpressionStrategy

default RelatedExpressionStrategy<N,T,B,TB,S,QI,R> getRelatedExpressionStrategy()

Description copied from interface: RelatedExpressionPart

Get the related expression strategy that was used to find the related expression of this anaphora relation.

Specified by:

getRelatedExpressionStrategy in interface RelatedExpressionPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>>

Returns:

The related expression strategy.

getAnaphor

default String getAnaphor()

Specified by:

getAnaphor in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

Returns:

A String representation of the anaphor initially entered by the user or chosen algorithmically. This will be identical to the String representation of the anaphor expression returned for underspecified anaphora relations but will differ to explicated anaphora relations.

See Also:

AnaphorPart.getAnaphorExpression()

getAnaphorExpression

default E getAnaphorExpression()

Description copied from interface: AnaphorPart

Get the expression that acts as anaphor. TODO: Replace by getTargetExpression()? But should the Anaphora interface be renamed, too, in this case?

Specified by:

getAnaphorExpression in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

Returns:

The expression that acts as anaphor.

getReferent

default Referent<TB,S,I,QI> getReferent()

Description copied from interface: AnaphorPart

Get the referent of the anaphor. TODO: Should this method be in an Anaphor or TargetExpression interface? TODO: Should other referents (e.g. the one of the related expression) be available, too?

Specified by:

getReferent in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

Returns:

The referent of the anaphor.

getAnaphorResolutionStrategy

default AnaphorResolutionStrategy<N,E,T,B,TB,S,I,QI,R,A> getAnaphorResolutionStrategy()

Description copied from interface: AnaphorPart

Get the anaphor resolution strategy that was used to find the referent of the anaphor involved in this anaphora relation.

Specified by:

getAnaphorResolutionStrategy in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

Returns:

The anaphor resolution strategy.

getReferentializationStrategy

default ReferentializationStrategy<E,TB,S,I,QI> getReferentializationStrategy()

Specified by:

getReferentializationStrategy in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

getBinding

default B getBinding()

Specified by:

getBinding in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

resolveType

default TB resolveType(S scope)

Specified by:

resolveType in interface AnaphorPart<N,E,T,B,TB extends B,S,I,QI,R extends RelatedExpression<N,T,B,TB,S,QI,R>,A extends ASTBasedAnaphora<N,E,T,B,TB,S,I,QI,R,A>>

getReferenceDescription

String getReferenceDescription()

Returns a description of the anaphora relation, to enable users to distinguish multiple anaphora relations that are referentially ambiguous.

The reference description does not contain information about the anaphor, but only information on the related expression and the referent.

isUnderspecified

@Deprecated
boolean isUnderspecified()

Deprecated.

The state of an anaphor should be represented internally in an implementation-specific way. This method will be removed in the future.

Returns:

true if this anaphora relation is underspecified, i.e. is not explicated.

See Also:

isExplicated()

isExplicated

@Deprecated
boolean isExplicated()

Deprecated.

The state of an anaphor should be represented internally in an implementation-specific way. This method will be removed in the future.

Returns:

true if this anaphora relation is explicated, i.e. is not underspecified.

See Also:

isUnderspecified()