edu.stanford.nlp.ie

Enum KBPRelationExtractor.RelationType

java.lang.Object

java.lang.Enum<KBPRelationExtractor.RelationType>

edu.stanford.nlp.ie.KBPRelationExtractor.RelationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KBPRelationExtractor.RelationType>

Enclosing interface:

KBPRelationExtractor

public static enum KBPRelationExtractor.RelationType
extends java.lang.Enum<KBPRelationExtractor.RelationType>

Known relation types (last updated for the 2013 shared task). Note that changing the constants here can have far-reaching consequences in loading serialized models, and various bits of code that have been hard-coded to these relation types (e.g., the various consistency filters).

Note: Neither per:spouse, org:founded_by, or X:organizations_founded are SINGLE relations in the spec - these are made single here because our system otherwise over-predicts them.

Author:

Gabor Angeli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KBPRelationExtractor.RelationType.Cardinality

Enum Constant Summary

Enum Constants

Enum Constant and Description
GPE_BIRTHS_IN_CITY
GPE_BIRTHS_IN_COUNTRY
GPE_BIRTHS_IN_STATE_OR_PROVINCE
GPE_DEATHS_IN_CITY
GPE_DEATHS_IN_COUNTRY
GPE_DEATHS_IN_STATE_OR_PROVINCE
GPE_EMPLOYEES
GPE_HEADQUARTERS_IN_CITY
GPE_HEADQUARTERS_IN_COUNTRY
GPE_HEADQUARTERS_IN_STATE_OR_PROVINCE
GPE_HOLDS_SHARES_IN
GPE_MEMBER_OF
GPE_ORGANIZATIONS_FOUNDED
GPE_RESIDENTS_IN_CITY
GPE_RESIDENTS_IN_COUNTRY
GPE_RESIDENTS_IN_STATE_OR_PROVINCE
GPE_SUBSIDIARIES
ORG_ALTERNATE_NAMES
ORG_CITY_OF_HEADQUARTERS
ORG_COUNTRY_OF_HEADQUARTERS
ORG_DISSOLVED
ORG_EMPLOYEES
ORG_FOUNDED
ORG_FOUNDED_BY
ORG_HOLDS_SHARES_IN
ORG_LOC_OF_HEADQUARTERS
ORG_MEMBER_OF
ORG_MEMBERS
ORG_NUMBER_OF_EMPLOYEES_SLASH_MEMBERS
ORG_ORGANIZATIONS_FOUNDED
ORG_PARENTS
ORG_POLITICAL_RELIGIOUS_AFFILIATION
ORG_SHAREHOLDERS
ORG_STATE_OR_PROVINCES_OF_HEADQUARTERS
ORG_STUDENTS
ORG_SUBSIDIARIES
ORG_TOP_MEMBERS_SLASH_EMPLOYEES
ORG_WEBSITE
PER_AGE
PER_ALTERNATE_NAMES
PER_CAUSE_OF_DEATH
PER_CHARGES
PER_CHILDREN
PER_CITIES_OF_RESIDENCE
PER_CITY_OF_BIRTH
PER_CITY_OF_DEATH
PER_COUNTRIES_OF_RESIDENCE
PER_COUNTRY_OF_BIRTH
PER_COUNTRY_OF_DEATH
PER_DATE_OF_BIRTH
PER_DATE_OF_DEATH
PER_EMPLOYEE_OF
PER_HOLDS_SHARES_IN
PER_LOC_OF_BIRTH
PER_LOC_OF_DEATH
PER_LOC_OF_RESIDENCE
PER_MEMBER_OF
PER_ORGANIZATIONS_FOUNDED
PER_ORIGIN
PER_OTHER_FAMILY
PER_PARENTS
PER_RELIGION
PER_SCHOOLS_ATTENDED
PER_SIBLINGS
PER_SPOUSE
PER_STATE_OR_PROVINCES_OF_BIRTH
PER_STATE_OR_PROVINCES_OF_DEATH
PER_STATE_OR_PROVINCES_OF_RESIDENCE
PER_TITLE
PER_TOP_EMPLOYEE_OF

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	canonicalName A canonical name for this relation type.
KBPRelationExtractor.RelationType.Cardinality	cardinality The cardinality of this entity.
KBPRelationExtractor.NERTag	entityType The entity type (left arg type) associated with this relation.
boolean	isOriginalRelation If true, realtation was one of the original (non-inverse) KBP relation.
double	priorProbability The prior for how often this relation occurs in the training data.
int	queryLimit A guess of the maximum number of results to query for this relation.
java.util.Set<KBPRelationExtractor.NERTag>	validNamedEntityLabels Valid named entity labels for the right argument to this relation
java.util.Set<java.lang.String>	validPOSPrefixes Valid POS [prefixes] for the right argument to this relation (e.g., can only take nouns, or can only take numbers, etc.)

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<KBPRelationExtractor.RelationType>	fromString(java.lang.String name) Find the slot for a given name
static boolean	plausiblyHasRelation(KBPRelationExtractor.NERTag entityType, KBPRelationExtractor.NERTag slotValueType) Returns whether two entity types could plausibly have a relation hold between them.
static KBPRelationExtractor.RelationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KBPRelationExtractor.RelationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PER_ALTERNATE_NAMES

public static final KBPRelationExtractor.RelationType PER_ALTERNATE_NAMES

PER_CHILDREN

public static final KBPRelationExtractor.RelationType PER_CHILDREN

PER_CITIES_OF_RESIDENCE

public static final KBPRelationExtractor.RelationType PER_CITIES_OF_RESIDENCE

PER_CITY_OF_BIRTH

public static final KBPRelationExtractor.RelationType PER_CITY_OF_BIRTH

PER_CITY_OF_DEATH

public static final KBPRelationExtractor.RelationType PER_CITY_OF_DEATH

PER_COUNTRIES_OF_RESIDENCE

public static final KBPRelationExtractor.RelationType PER_COUNTRIES_OF_RESIDENCE

PER_COUNTRY_OF_BIRTH

public static final KBPRelationExtractor.RelationType PER_COUNTRY_OF_BIRTH

PER_COUNTRY_OF_DEATH

public static final KBPRelationExtractor.RelationType PER_COUNTRY_OF_DEATH

PER_EMPLOYEE_OF

public static final KBPRelationExtractor.RelationType PER_EMPLOYEE_OF

PER_LOC_OF_BIRTH

public static final KBPRelationExtractor.RelationType PER_LOC_OF_BIRTH

PER_LOC_OF_DEATH

public static final KBPRelationExtractor.RelationType PER_LOC_OF_DEATH

PER_LOC_OF_RESIDENCE

public static final KBPRelationExtractor.RelationType PER_LOC_OF_RESIDENCE

PER_MEMBER_OF

public static final KBPRelationExtractor.RelationType PER_MEMBER_OF

PER_ORIGIN

public static final KBPRelationExtractor.RelationType PER_ORIGIN

PER_OTHER_FAMILY

public static final KBPRelationExtractor.RelationType PER_OTHER_FAMILY

PER_PARENTS

public static final KBPRelationExtractor.RelationType PER_PARENTS

PER_SCHOOLS_ATTENDED

public static final KBPRelationExtractor.RelationType PER_SCHOOLS_ATTENDED

PER_SIBLINGS

public static final KBPRelationExtractor.RelationType PER_SIBLINGS

PER_SPOUSE

public static final KBPRelationExtractor.RelationType PER_SPOUSE

PER_STATE_OR_PROVINCES_OF_BIRTH

public static final KBPRelationExtractor.RelationType PER_STATE_OR_PROVINCES_OF_BIRTH

PER_STATE_OR_PROVINCES_OF_DEATH

public static final KBPRelationExtractor.RelationType PER_STATE_OR_PROVINCES_OF_DEATH

PER_STATE_OR_PROVINCES_OF_RESIDENCE

public static final KBPRelationExtractor.RelationType PER_STATE_OR_PROVINCES_OF_RESIDENCE

PER_AGE

public static final KBPRelationExtractor.RelationType PER_AGE

PER_DATE_OF_BIRTH

public static final KBPRelationExtractor.RelationType PER_DATE_OF_BIRTH

PER_DATE_OF_DEATH

public static final KBPRelationExtractor.RelationType PER_DATE_OF_DEATH

PER_CAUSE_OF_DEATH

public static final KBPRelationExtractor.RelationType PER_CAUSE_OF_DEATH

PER_CHARGES

public static final KBPRelationExtractor.RelationType PER_CHARGES

PER_RELIGION

public static final KBPRelationExtractor.RelationType PER_RELIGION

PER_TITLE

public static final KBPRelationExtractor.RelationType PER_TITLE

ORG_ALTERNATE_NAMES

public static final KBPRelationExtractor.RelationType ORG_ALTERNATE_NAMES

ORG_CITY_OF_HEADQUARTERS

public static final KBPRelationExtractor.RelationType ORG_CITY_OF_HEADQUARTERS

ORG_COUNTRY_OF_HEADQUARTERS

public static final KBPRelationExtractor.RelationType ORG_COUNTRY_OF_HEADQUARTERS

ORG_FOUNDED_BY

public static final KBPRelationExtractor.RelationType ORG_FOUNDED_BY

ORG_LOC_OF_HEADQUARTERS

public static final KBPRelationExtractor.RelationType ORG_LOC_OF_HEADQUARTERS

ORG_MEMBER_OF

public static final KBPRelationExtractor.RelationType ORG_MEMBER_OF

ORG_MEMBERS

public static final KBPRelationExtractor.RelationType ORG_MEMBERS

ORG_PARENTS

public static final KBPRelationExtractor.RelationType ORG_PARENTS

ORG_POLITICAL_RELIGIOUS_AFFILIATION

public static final KBPRelationExtractor.RelationType ORG_POLITICAL_RELIGIOUS_AFFILIATION

ORG_SHAREHOLDERS

public static final KBPRelationExtractor.RelationType ORG_SHAREHOLDERS

ORG_STATE_OR_PROVINCES_OF_HEADQUARTERS

public static final KBPRelationExtractor.RelationType ORG_STATE_OR_PROVINCES_OF_HEADQUARTERS

ORG_SUBSIDIARIES

public static final KBPRelationExtractor.RelationType ORG_SUBSIDIARIES

ORG_TOP_MEMBERS_SLASH_EMPLOYEES

public static final KBPRelationExtractor.RelationType ORG_TOP_MEMBERS_SLASH_EMPLOYEES

ORG_DISSOLVED

public static final KBPRelationExtractor.RelationType ORG_DISSOLVED

ORG_FOUNDED

public static final KBPRelationExtractor.RelationType ORG_FOUNDED

ORG_NUMBER_OF_EMPLOYEES_SLASH_MEMBERS

public static final KBPRelationExtractor.RelationType ORG_NUMBER_OF_EMPLOYEES_SLASH_MEMBERS

ORG_WEBSITE

public static final KBPRelationExtractor.RelationType ORG_WEBSITE

ORG_EMPLOYEES

public static final KBPRelationExtractor.RelationType ORG_EMPLOYEES

GPE_EMPLOYEES

public static final KBPRelationExtractor.RelationType GPE_EMPLOYEES

ORG_STUDENTS

public static final KBPRelationExtractor.RelationType ORG_STUDENTS

GPE_BIRTHS_IN_CITY

public static final KBPRelationExtractor.RelationType GPE_BIRTHS_IN_CITY

GPE_BIRTHS_IN_STATE_OR_PROVINCE

public static final KBPRelationExtractor.RelationType GPE_BIRTHS_IN_STATE_OR_PROVINCE

GPE_BIRTHS_IN_COUNTRY

public static final KBPRelationExtractor.RelationType GPE_BIRTHS_IN_COUNTRY

GPE_RESIDENTS_IN_CITY

public static final KBPRelationExtractor.RelationType GPE_RESIDENTS_IN_CITY

GPE_RESIDENTS_IN_STATE_OR_PROVINCE

public static final KBPRelationExtractor.RelationType GPE_RESIDENTS_IN_STATE_OR_PROVINCE

GPE_RESIDENTS_IN_COUNTRY

public static final KBPRelationExtractor.RelationType GPE_RESIDENTS_IN_COUNTRY

GPE_DEATHS_IN_CITY

public static final KBPRelationExtractor.RelationType GPE_DEATHS_IN_CITY

GPE_DEATHS_IN_STATE_OR_PROVINCE

public static final KBPRelationExtractor.RelationType GPE_DEATHS_IN_STATE_OR_PROVINCE

GPE_DEATHS_IN_COUNTRY

public static final KBPRelationExtractor.RelationType GPE_DEATHS_IN_COUNTRY

PER_HOLDS_SHARES_IN

public static final KBPRelationExtractor.RelationType PER_HOLDS_SHARES_IN

GPE_HOLDS_SHARES_IN

public static final KBPRelationExtractor.RelationType GPE_HOLDS_SHARES_IN

ORG_HOLDS_SHARES_IN

public static final KBPRelationExtractor.RelationType ORG_HOLDS_SHARES_IN

PER_ORGANIZATIONS_FOUNDED

public static final KBPRelationExtractor.RelationType PER_ORGANIZATIONS_FOUNDED

GPE_ORGANIZATIONS_FOUNDED

public static final KBPRelationExtractor.RelationType GPE_ORGANIZATIONS_FOUNDED

ORG_ORGANIZATIONS_FOUNDED

public static final KBPRelationExtractor.RelationType ORG_ORGANIZATIONS_FOUNDED

PER_TOP_EMPLOYEE_OF

public static final KBPRelationExtractor.RelationType PER_TOP_EMPLOYEE_OF

GPE_MEMBER_OF

public static final KBPRelationExtractor.RelationType GPE_MEMBER_OF

GPE_SUBSIDIARIES

public static final KBPRelationExtractor.RelationType GPE_SUBSIDIARIES

GPE_HEADQUARTERS_IN_CITY

public static final KBPRelationExtractor.RelationType GPE_HEADQUARTERS_IN_CITY

GPE_HEADQUARTERS_IN_STATE_OR_PROVINCE

public static final KBPRelationExtractor.RelationType GPE_HEADQUARTERS_IN_STATE_OR_PROVINCE

GPE_HEADQUARTERS_IN_COUNTRY

public static final KBPRelationExtractor.RelationType GPE_HEADQUARTERS_IN_COUNTRY

Field Detail

canonicalName

public final java.lang.String canonicalName

A canonical name for this relation type. This is the official 2010 relation name, that has since changed.

isOriginalRelation

public final boolean isOriginalRelation

If true, realtation was one of the original (non-inverse) KBP relation.

queryLimit

public final int queryLimit

A guess of the maximum number of results to query for this relation. Only really relevant for cold start.

entityType

public final KBPRelationExtractor.NERTag entityType

The entity type (left arg type) associated with this relation. That is, either a PERSON or an ORGANIZATION "slot".

cardinality

public final KBPRelationExtractor.RelationType.Cardinality cardinality

The cardinality of this entity. That is, can multiple right arguments participate in this relation (born_in vs. lived_in)

validNamedEntityLabels

public final java.util.Set<KBPRelationExtractor.NERTag> validNamedEntityLabels

Valid named entity labels for the right argument to this relation

validPOSPrefixes

public final java.util.Set<java.lang.String> validPOSPrefixes

Valid POS [prefixes] for the right argument to this relation (e.g., can only take nouns, or can only take numbers, etc.)

priorProbability

public final double priorProbability

The prior for how often this relation occurs in the training data. Note that this prior is not necessarily accurate for the test data.

Method Detail

values

public static KBPRelationExtractor.RelationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KBPRelationExtractor.RelationType c : KBPRelationExtractor.RelationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KBPRelationExtractor.RelationType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromString

public static java.util.Optional<KBPRelationExtractor.RelationType> fromString(java.lang.String name)

Find the slot for a given name

plausiblyHasRelation

public static boolean plausiblyHasRelation(KBPRelationExtractor.NERTag entityType,
                                           KBPRelationExtractor.NERTag slotValueType)

Returns whether two entity types could plausibly have a relation hold between them. That is, is there a known relation type that would hold between these two entity types.

Parameters:

entityType - The NER tag of the entity.

slotValueType - The NER tag of the slot value.

Returns:

True if there is a plausible relation which could occur between these two types.