/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file 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.amazonaws.services.comprehendmedical.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* The collection of medical entities extracted from the input text and their associated information. For each entity, * the response provides the entity text, the entity category, where the entity text begins and ends, and the level of * confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are * also returned. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RxNormEntity implements Serializable, Cloneable, StructuredPojo { /** ** The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather * than a global unique identifier. *
*/ private Integer id; /** ** The segment of input text extracted from which the entity was detected. *
*/ private String text; /** *
* The category of the entity. The recognized categories are GENERIC
or BRAND_NAME
.
*
* Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION
.
*
* The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. *
*/ private Float score; /** ** The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 * code point in the string. *
*/ private Integer beginOffset; /** ** The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 * code point in the string. *
*/ private Integer endOffset; /** *
* The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
* DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*
* Contextual information for the entity. *
*/ private java.util.List* The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
*/ private java.util.List* The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather * than a global unique identifier. *
* * @param id * The numeric identifier for the entity. This is a monotonically increasing id unique within this response * rather than a global unique identifier. */ public void setId(Integer id) { this.id = id; } /** ** The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather * than a global unique identifier. *
* * @return The numeric identifier for the entity. This is a monotonically increasing id unique within this response * rather than a global unique identifier. */ public Integer getId() { return this.id; } /** ** The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather * than a global unique identifier. *
* * @param id * The numeric identifier for the entity. This is a monotonically increasing id unique within this response * rather than a global unique identifier. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withId(Integer id) { setId(id); return this; } /** ** The segment of input text extracted from which the entity was detected. *
* * @param text * The segment of input text extracted from which the entity was detected. */ public void setText(String text) { this.text = text; } /** ** The segment of input text extracted from which the entity was detected. *
* * @return The segment of input text extracted from which the entity was detected. */ public String getText() { return this.text; } /** ** The segment of input text extracted from which the entity was detected. *
* * @param text * The segment of input text extracted from which the entity was detected. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withText(String text) { setText(text); return this; } /** *
* The category of the entity. The recognized categories are GENERIC
or BRAND_NAME
.
*
GENERIC
or BRAND_NAME
.
* @see RxNormEntityCategory
*/
public void setCategory(String category) {
this.category = category;
}
/**
*
* The category of the entity. The recognized categories are GENERIC
or BRAND_NAME
.
*
GENERIC
or BRAND_NAME
* .
* @see RxNormEntityCategory
*/
public String getCategory() {
return this.category;
}
/**
*
* The category of the entity. The recognized categories are GENERIC
or BRAND_NAME
.
*
GENERIC
or BRAND_NAME
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RxNormEntityCategory
*/
public RxNormEntity withCategory(String category) {
setCategory(category);
return this;
}
/**
*
* The category of the entity. The recognized categories are GENERIC
or BRAND_NAME
.
*
GENERIC
or BRAND_NAME
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RxNormEntityCategory
*/
public RxNormEntity withCategory(RxNormEntityCategory category) {
this.category = category.toString();
return this;
}
/**
*
* Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION
.
*
MEDICATION
.
* @see RxNormEntityType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION
.
*
MEDICATION
.
* @see RxNormEntityType
*/
public String getType() {
return this.type;
}
/**
*
* Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION
.
*
MEDICATION
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RxNormEntityType
*/
public RxNormEntity withType(String type) {
setType(type);
return this;
}
/**
*
* Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION
.
*
MEDICATION
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RxNormEntityType
*/
public RxNormEntity withType(RxNormEntityType type) {
this.type = type.toString();
return this;
}
/**
* * The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. *
* * @param score * The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. */ public void setScore(Float score) { this.score = score; } /** ** The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. *
* * @return The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. */ public Float getScore() { return this.score; } /** ** The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. *
* * @param score * The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withScore(Float score) { setScore(score); return this; } /** ** The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 * code point in the string. *
* * @param beginOffset * The 0-based character offset in the input text that shows where the entity begins. The offset returns the * UTF-8 code point in the string. */ public void setBeginOffset(Integer beginOffset) { this.beginOffset = beginOffset; } /** ** The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 * code point in the string. *
* * @return The 0-based character offset in the input text that shows where the entity begins. The offset returns the * UTF-8 code point in the string. */ public Integer getBeginOffset() { return this.beginOffset; } /** ** The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 * code point in the string. *
* * @param beginOffset * The 0-based character offset in the input text that shows where the entity begins. The offset returns the * UTF-8 code point in the string. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withBeginOffset(Integer beginOffset) { setBeginOffset(beginOffset); return this; } /** ** The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 * code point in the string. *
* * @param endOffset * The 0-based character offset in the input text that shows where the entity ends. The offset returns the * UTF-8 code point in the string. */ public void setEndOffset(Integer endOffset) { this.endOffset = endOffset; } /** ** The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 * code point in the string. *
* * @return The 0-based character offset in the input text that shows where the entity ends. The offset returns the * UTF-8 code point in the string. */ public Integer getEndOffset() { return this.endOffset; } /** ** The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 * code point in the string. *
* * @param endOffset * The 0-based character offset in the input text that shows where the entity ends. The offset returns the * UTF-8 code point in the string. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withEndOffset(Integer endOffset) { setEndOffset(endOffset); return this; } /** *
* The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
* DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*
DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*/
public java.util.List
* The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
* DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*
DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*/
public void setAttributes(java.util.Collection
* The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
* DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setAttributes(java.util.Collection)} or {@link #withAttributes(java.util.Collection)} if you want to * override the existing values. *
* * @param attributes * The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are *DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RxNormEntity withAttributes(RxNormAttribute... attributes) {
if (this.attributes == null) {
setAttributes(new java.util.ArrayList
* The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
* DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
*
DOSAGE
, DURATION
, FORM
, FREQUENCY
, RATE
,
* ROUTE_OR_MODE
, and STRENGTH
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RxNormEntity withAttributes(java.util.Collection* Contextual information for the entity. *
* * @return Contextual information for the entity. */ public java.util.List* Contextual information for the entity. *
* * @param traits * Contextual information for the entity. */ public void setTraits(java.util.Collection* Contextual information for the entity. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTraits(java.util.Collection)} or {@link #withTraits(java.util.Collection)} if you want to override the * existing values. *
* * @param traits * Contextual information for the entity. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withTraits(RxNormTrait... traits) { if (this.traits == null) { setTraits(new java.util.ArrayList* Contextual information for the entity. *
* * @param traits * Contextual information for the entity. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withTraits(java.util.Collection* The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
* * @return The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the * match. */ public java.util.List* The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
* * @param rxNormConcepts * The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the * match. */ public void setRxNormConcepts(java.util.Collection* The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setRxNormConcepts(java.util.Collection)} or {@link #withRxNormConcepts(java.util.Collection)} if you want * to override the existing values. *
* * @param rxNormConcepts * The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the * match. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withRxNormConcepts(RxNormConcept... rxNormConcepts) { if (this.rxNormConcepts == null) { setRxNormConcepts(new java.util.ArrayList* The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
* * @param rxNormConcepts * The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the * match. * @return Returns a reference to this object so that method calls can be chained together. */ public RxNormEntity withRxNormConcepts(java.util.Collection