opennlp.tools.coref.resolver
Interface Resolver

All Known Implementing Classes:
AbstractResolver, CommonNounResolver, DefiniteNounResolver, IsAResolver, MaxentResolver, PerfectResolver, PluralNounResolver, PluralPronounResolver, ProperNounResolver, SingularPronounResolver, SpeechPronounResolver

public interface Resolver

Interface for coreference resolvers.


Method Summary
 boolean canResolve(MentionContext mention)
          Returns true if this resolver is able to resolve the referring expression of the same type as the specified mention.
 DiscourseEntity resolve(MentionContext ec, DiscourseModel dm)
          Resolve this referring expression to a discourse entity in the discourse model.
 DiscourseEntity retain(MentionContext mention, DiscourseModel model)
          Uses the specified mention and discourse model to train this resolver.
 void train()
          Retrains model on examples for which retain was called.
 

Method Detail

canResolve

boolean canResolve(MentionContext mention)
Returns true if this resolver is able to resolve the referring expression of the same type as the specified mention.

Parameters:
mention - The mention being considered for resolution.
Returns:
true if the resolver handles this type of referring expression, false otherwise.

resolve

DiscourseEntity resolve(MentionContext ec,
                        DiscourseModel dm)
Resolve this referring expression to a discourse entity in the discourse model.

Parameters:
ec - the referring expression.
dm - the discourse model.
Returns:
the discourse entity which the resolver believes this referring expression refers to or null if no discourse entity is coreferent with the referring expression.

retain

DiscourseEntity retain(MentionContext mention,
                       DiscourseModel model)
Uses the specified mention and discourse model to train this resolver. All mentions sent to this method need to have their id fields set to indicate coreference relationships.

Parameters:
mention - The mention which is being used for training.
model - the discourse model.
Returns:
the discourse entity which is referred to by the referring expression or null if no discourse entity is referenced.

train

void train()
           throws IOException
Retrains model on examples for which retain was called.

Throws:
IOException


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.