com.basistech.rosette.dm.EntityMention Maven / Gradle / Ivy
/*
* Copyright 2018 Basis Technology Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.basistech.rosette.dm;
import com.google.common.base.MoreObjects;
import lombok.EqualsAndHashCode;
import java.io.Serializable;
import java.util.Map;
/**
* A mention of a entity in the text. For example, "George" and
* "George Washington" are mentions of type "PERSON".
* @deprecated This class is replaced by {@link Mention}.
*/
@Deprecated
@EqualsAndHashCode(callSuper = true)
public class EntityMention extends Attribute implements Serializable {
private static final long serialVersionUID = 250L;
private final String entityType;
private final Double confidence;
private final Double linkingConfidence;
private final Integer coreferenceChainId;
private final Integer flags; // allow to be null if none!
private final String source;
private final String subsource;
private final String normalized;
protected EntityMention(int startOffset, int endOffset,
String entityType,
Integer coreferenceChainId,
Double confidence, Double linkingConfidence, Integer flags,
String source, String subsource, String normalized,
Map extendedProperties) {
super(startOffset, endOffset, extendedProperties);
this.entityType = entityType;
this.confidence = confidence;
this.linkingConfidence = linkingConfidence;
this.coreferenceChainId = coreferenceChainId;
this.flags = flags;
this.source = source;
this.subsource = subsource;
this.normalized = normalized;
}
/**
* Returns the type of the entity. For example, "PERSON", "LOCATION",
* "ORGANIZATION".
*
* @return the type of entity
*/
public String getEntityType() {
return entityType;
}
/**
* Returns the confidence of the entity extractor in identifying this mention.
*
* @return the confidence of the entity extractor in identifying this mention.
* This value will be null if there is no calculated confidence value.
*/
public Double getConfidence() {
return confidence;
}
/**
* Returns the linking confidence of the kb-linker in link this mention and entity id.
*
* @return the linking confidence of the kb-linker in link this mention and entity id.
* This value will be null if there is no calculated confidence value.
*/
public Double getLinkingConfidence() {
return linkingConfidence;
}
/**
* Returns a chain id that links together entity mentions that refer to the
* same entity as determined by in-document analysis. This is {@code null}
* if no in-document
* coreference information is available. Currently, the chain id is the
* index (into the {@code EntityMention} list) of the head mention of the
* chain. The head mention is the (first) longest mention in the chain.
*
* @return the coreference chain id, or null if chaining has not been applied
*/
public Integer getCoreferenceChainId() {
return coreferenceChainId;
}
/**
* Returns flags associated with a mention. Interpretation of the flags varies
* by extractor and language.
*
* @return flags associated with the mention. These may be null
* (rather than 0) if there are no flags.
*/
public Integer getFlags() {
return flags;
}
/**
* Returns the entity extraction source that produced this entity. For
* example, "statistical", "regex", "gazetteer".
*
* @return the entity extraction source
*/
public String getSource() {
return source;
}
/**
* Returns the entity extraction subsource that produced this entity.
* This is usually filename for the regular expression file or gazetteer in which the entity appears.
* For example, "./data/gazetteer/eng/accept/gaz-LE.bin"
*
* @return the entity extraction subsource
*/
public String getSubsource() {
return subsource;
}
/**
* Returns the normalized form of the mention. This form typically
* normalizes spaces spaces and removes embedded newlines. It may omit
* prefixes in languages like Arabic. This is not a canonical way to
* refer to the entity (see {@link com.basistech.rosette.dm.ResolvedEntity})
* but rather a simplified form of this particular mention text.
*
* @return the normalized form of the mention
*/
public String getNormalized() {
return normalized;
}
@Override
protected MoreObjects.ToStringHelper toStringHelper() {
return super.toStringHelper()
.add("entityType", entityType)
.add("confidence", confidence)
.add("linkingConfidence", linkingConfidence)
.add("coreferenceChainId", coreferenceChainId)
.add("flags", flags)
.add("source", source)
.add("subsource", subsource)
.add("normalized", normalized);
}
/**
* A builder for entity mentions.
*/
public static class Builder extends Attribute.Builder {
private String entityType;
private Double confidence;
private Double linkingConfidence;
private Integer coreferenceChainId;
private Integer flags;
private String source;
private String subsource;
private String normalized;
/**
* Constructs a builder with the minimal required information for an entity mention.
*
* @param startOffset the start offset in the text, in characters
* @param endOffset the end offset in the text, in characters
* @param entityType the type of entity (e.g. "PERSON").
*/
public Builder(int startOffset, int endOffset, String entityType) {
super(startOffset, endOffset);
this.entityType = entityType;
}
/**
* Constructs a builder initialized with information from an existing entity mention.
*
* @param toCopy the mention to copy.
*/
public Builder(EntityMention toCopy) {
super(toCopy);
this.entityType = toCopy.entityType;
this.confidence = toCopy.confidence;
this.linkingConfidence = linkingConfidence;
this.coreferenceChainId = toCopy.coreferenceChainId;
this.flags = toCopy.flags;
this.source = toCopy.source;
this.subsource = toCopy.subsource;
this.normalized = toCopy.normalized;
}
/**
* Specifies the entity type.
*
* @param entityType the entity type
* @return this
*/
public Builder entityType(String entityType) {
this.entityType = entityType;
return this;
}
/**
* Specifies the confidence.
*
* @param confidence the confidence, or null to indicate that no confidence is available.
* @return this
*/
public Builder confidence(Double confidence) {
this.confidence = confidence;
return this;
}
/**
* Specifies the linking confidence.
*
* @param linkingConfidence the confidence, or null to indicate that no confidence is available.
* @return this
*/
public Builder linkingConfidence(Double linkingConfidence) {
this.linkingConfidence = linkingConfidence;
return this;
}
/**
* Specifies the coreference chain identifier. See {@link com.basistech.rosette.dm.EntityMention#getCoreferenceChainId()}.
*
* @param coreferenceChainId the chain identifier, or null for a mention that is not linked.
* @return this
*/
public Builder coreferenceChainId(Integer coreferenceChainId) {
this.coreferenceChainId = coreferenceChainId;
return this;
}
/**
* Specifies the flags.
*
* @param flags flags value
* @return this
*/
public Builder flags(int flags) {
this.flags = flags;
return this;
}
/**
* Specifies the source of this mention.
*
* @param source the source
* @return this
*/
public Builder source(String source) {
this.source = source;
return this;
}
/**
* Specifies the subsource of this mention.
*
* @param subsource the subsource
* @return this
*/
public Builder subsource(String subsource) {
this.subsource = subsource;
return this;
}
/**
* Specifies the normalized form of this mention.
*
* @param normalized the normalized form
* @return this
*/
public Builder normalized(String normalized) {
this.normalized = normalized;
return this;
}
/**
* Builds the immutable mention.
*
* @return the mention
*/
public EntityMention build() {
return new EntityMention(startOffset, endOffset, entityType, coreferenceChainId, confidence,
linkingConfidence, flags, source, subsource, normalized, buildExtendedProperties());
}
@Override
protected Builder getThis() {
return this;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy