prajna.entity

Interface EntityVerifier

All Known Implementing Classes:

CompositeExtractor, DateTimeVerifier, DbpediaVerifier, GeoNamesAugmenter, GeoNamesVerifier

public interface EntityVerifier

Entity Verifiers validate the results of entity extractors by checking their types. An Entity Verifier might not be able to extract entities, but it could verify if the extracted entities are valid.

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
EntityType	determineType(java.lang.String term) Determine the entity type for a particular term.
java.lang.String	getModel() Get the model string.
java.util.Set<EntityType>	getSupportedTypes() Return the list of types this verifier can verify.
java.lang.String	normalize(java.lang.String term, EntityType type) Get a normalized form for this entity and type.
void	setModel(java.lang.String model) Set the model for this entity verifier.
boolean	verifyType(java.lang.String term, EntityType type) Verify that the term matches the type.

Method Detail

determineType

EntityType determineType(java.lang.String term)

Determine the entity type for a particular term. This method could be used to identify a term that is originally of type UNKNOWN. If the verifier can verify that the term is an entity, but not its type, then it should return EntityType.UNKNOWN. If the term is not an entity recognized by this verifier, it should return null.

Parameters:

term - the term to check. This is the extracted entity

Returns:

the entity type for the term.

getModel

java.lang.String getModel()

Get the model string. The interpretation of the model is dependent on the verifier.

Returns:

the model string, if any

getSupportedTypes

java.util.Set<EntityType> getSupportedTypes()

Return the list of types this verifier can verify.

Returns:

the set of types supported.

normalize

java.lang.String normalize(java.lang.String term,
                         EntityType type)

Get a normalized form for this entity and type. This method ensures that any entity of the specified type will conform to a particular format, or resolve spelling differences, etc. If the term is not supported by this verifier, or if the verifier cannot normalize the term, null is returned.

Parameters:

term - the term to normalize

type - the entity type

Returns:

a normalized string

setModel

void setModel(java.lang.String model)

Set the model for this entity verifier. The actual content of the model parameter is unspecified, and may be a file path, URL, or other configuration information.

Parameters:

model - the model for the entity verifier

verifyType

boolean verifyType(java.lang.String term,
                 EntityType type)

Verify that the term matches the type. If the verifier cannot verify the term, or cannot positively identify it as the specified type, it should return false

Parameters:

term - the term to check. This is the extracted entity

type - the type to check against.

Returns:

true if and only if the verifier can positively determine that the term matches the type, false otherwise.