/* * 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 SNOMEDCTEntity 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 as this entity. *
*/ private String text; /** ** The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. *
*/ private String category; /** ** Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. *
*/ private String type; /** ** 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; /** ** An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as * the dosage of a medication taken. *
*/ private java.util.List* Contextual information for the entity. *
*/ private java.util.List* The SNOMED 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 SNOMEDCTEntity withId(Integer id) { setId(id); return this; } /** ** The segment of input text extracted as this entity. *
* * @param text * The segment of input text extracted as this entity. */ public void setText(String text) { this.text = text; } /** ** The segment of input text extracted as this entity. *
* * @return The segment of input text extracted as this entity. */ public String getText() { return this.text; } /** ** The segment of input text extracted as this entity. *
* * @param text * The segment of input text extracted as this entity. * @return Returns a reference to this object so that method calls can be chained together. */ public SNOMEDCTEntity withText(String text) { setText(text); return this; } /** ** The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. *
* * @param category * The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. * @see SNOMEDCTEntityCategory */ public void setCategory(String category) { this.category = category; } /** ** The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. *
* * @return The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. * @see SNOMEDCTEntityCategory */ public String getCategory() { return this.category; } /** ** The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. *
* * @param category * The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. * @return Returns a reference to this object so that method calls can be chained together. * @see SNOMEDCTEntityCategory */ public SNOMEDCTEntity withCategory(String category) { setCategory(category); return this; } /** ** The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. *
* * @param category * The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or * TEST_TREATMENT_PROCEDURE. * @return Returns a reference to this object so that method calls can be chained together. * @see SNOMEDCTEntityCategory */ public SNOMEDCTEntity withCategory(SNOMEDCTEntityCategory category) { this.category = category.toString(); return this; } /** ** Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. *
* * @param type * Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. * @see SNOMEDCTEntityType */ public void setType(String type) { this.type = type; } /** ** Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. *
* * @return Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. * @see SNOMEDCTEntityType */ public String getType() { return this.type; } /** ** Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. *
* * @param type * Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. * @return Returns a reference to this object so that method calls can be chained together. * @see SNOMEDCTEntityType */ public SNOMEDCTEntity withType(String type) { setType(type); return this; } /** ** Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. *
* * @param type * Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, * DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. * @return Returns a reference to this object so that method calls can be chained together. * @see SNOMEDCTEntityType */ public SNOMEDCTEntity withType(SNOMEDCTEntityType 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 SNOMEDCTEntity 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 SNOMEDCTEntity 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 SNOMEDCTEntity withEndOffset(Integer endOffset) { setEndOffset(endOffset); return this; } /** ** An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as * the dosage of a medication taken. *
* * @return An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, * such as the dosage of a medication taken. */ public java.util.List* An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as * the dosage of a medication taken. *
* * @param attributes * An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, * such as the dosage of a medication taken. */ public void setAttributes(java.util.Collection* An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as * the dosage of a medication taken. *
** 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 * An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, * such as the dosage of a medication taken. * @return Returns a reference to this object so that method calls can be chained together. */ public SNOMEDCTEntity withAttributes(SNOMEDCTAttribute... attributes) { if (this.attributes == null) { setAttributes(new java.util.ArrayList* An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as * the dosage of a medication taken. *
* * @param attributes * An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, * such as the dosage of a medication taken. * @return Returns a reference to this object so that method calls can be chained together. */ public SNOMEDCTEntity 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 SNOMEDCTEntity withTraits(SNOMEDCTTrait... 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 SNOMEDCTEntity withTraits(java.util.Collection* The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
* * @return The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the * match. */ public java.util.List* The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
* * @param sNOMEDCTConcepts * The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the * match. */ public void setSNOMEDCTConcepts(java.util.Collection* The SNOMED 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 #setSNOMEDCTConcepts(java.util.Collection)} or {@link #withSNOMEDCTConcepts(java.util.Collection)} if you * want to override the existing values. *
* * @param sNOMEDCTConcepts * The SNOMED 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 SNOMEDCTEntity withSNOMEDCTConcepts(SNOMEDCTConcept... sNOMEDCTConcepts) { if (this.sNOMEDCTConcepts == null) { setSNOMEDCTConcepts(new java.util.ArrayList* The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match. *
* * @param sNOMEDCTConcepts * The SNOMED 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 SNOMEDCTEntity withSNOMEDCTConcepts(java.util.Collection