RxNormEntity (AWS Java SDK for AWS Comprehend Medical 1.11.848 API)

java.lang.Object
- com.amazonaws.services.comprehendmedical.model.RxNormEntity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RxNormEntity
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RxNormEntity()

Constructors
Constructor and Description
`RxNormEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RxNormEntity`	`clone()`
`boolean`	`equals(Object obj)`
`List<RxNormAttribute>`	`getAttributes()` The extracted attributes that relate to the entity.
`Integer`	`getBeginOffset()` The 0-based character offset in the input text that shows where the entity begins.
`String`	`getCategory()` The category of the entity.
`Integer`	`getEndOffset()` The 0-based character offset in the input text that shows where the entity ends.
`Integer`	`getId()` The numeric identifier for the entity.
`List<RxNormConcept>`	`getRxNormConcepts()` The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`Float`	`getScore()` The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
`String`	`getText()` The segment of input text extracted from which the entity was detected.
`List<RxNormTrait>`	`getTraits()` Contextual information for the entity.
`String`	`getType()` Describes the specific type of entity.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAttributes(Collection<RxNormAttribute> attributes)` The extracted attributes that relate to the entity.
`void`	`setBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the entity begins.
`void`	`setCategory(String category)` The category of the entity.
`void`	`setEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the entity ends.
`void`	`setId(Integer id)` The numeric identifier for the entity.
`void`	`setRxNormConcepts(Collection<RxNormConcept> rxNormConcepts)` The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`void`	`setScore(Float score)` The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
`void`	`setText(String text)` The segment of input text extracted from which the entity was detected.
`void`	`setTraits(Collection<RxNormTrait> traits)` Contextual information for the entity.
`void`	`setType(String type)` Describes the specific type of entity.
`String`	`toString()` Returns a string representation of this object.
`RxNormEntity`	`withAttributes(Collection<RxNormAttribute> attributes)` The extracted attributes that relate to the entity.
`RxNormEntity`	`withAttributes(RxNormAttribute... attributes)` The extracted attributes that relate to the entity.
`RxNormEntity`	`withBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the entity begins.
`RxNormEntity`	`withCategory(RxNormEntityCategory category)` The category of the entity.
`RxNormEntity`	`withCategory(String category)` The category of the entity.
`RxNormEntity`	`withEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the entity ends.
`RxNormEntity`	`withId(Integer id)` The numeric identifier for the entity.
`RxNormEntity`	`withRxNormConcepts(Collection<RxNormConcept> rxNormConcepts)` The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`RxNormEntity`	`withRxNormConcepts(RxNormConcept... rxNormConcepts)` The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`RxNormEntity`	`withScore(Float score)` The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
`RxNormEntity`	`withText(String text)` The segment of input text extracted from which the entity was detected.
`RxNormEntity`	`withTraits(Collection<RxNormTrait> traits)` Contextual information for the entity.
`RxNormEntity`	`withTraits(RxNormTrait... traits)` Contextual information for the entity.
`RxNormEntity`	`withType(RxNormEntityType type)` Describes the specific type of entity.
`RxNormEntity`	`withType(String type)` Describes the specific type of entity.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RxNormEntity
```
public RxNormEntity()
```
- Method Detail
  - setId
```
public void setId(Integer id)
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Parameters:
    
    id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - getId
```
public Integer getId()
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Returns:
    
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - withId
```
public RxNormEntity withId(Integer id)
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Parameters:
    
    id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setText
```
public void setText(String text)
```
    The segment of input text extracted from which the entity was detected.
    
    Parameters:
    
    text - The segment of input text extracted from which the entity was detected.
  - getText
```
public String getText()
```
    The segment of input text extracted from which the entity was detected.
    
    Returns:
    
    The segment of input text extracted from which the entity was detected.
  - withText
```
public RxNormEntity withText(String text)
```
    The segment of input text extracted from which the entity was detected.
    
    Parameters:
    
    text - The segment of input text extracted from which the entity was detected.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCategory
```
public void setCategory(String category)
```
    The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    Parameters:
    
    category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    See Also:
    
    RxNormEntityCategory
  - getCategory
```
public String getCategory()
```
    The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    Returns:
    
    The category of the entity. The recognized categories are GENERIC or BRAND_NAME .
    
    See Also:
    
    RxNormEntityCategory
  - withCategory
```
public RxNormEntity withCategory(String category)
```
    The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    Parameters:
    
    category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RxNormEntityCategory
  - withCategory
```
public RxNormEntity withCategory(RxNormEntityCategory category)
```
    The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    Parameters:
    
    category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RxNormEntityCategory
  - setType
```
public void setType(String type)
```
    Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    Parameters:
    
    type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    See Also:
    
    RxNormEntityType
  - getType
```
public String getType()
```
    Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    Returns:
    
    Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    See Also:
    
    RxNormEntityType
  - withType
```
public RxNormEntity withType(String type)
```
    Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    Parameters:
    
    type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RxNormEntityType
  - withType
```
public RxNormEntity withType(RxNormEntityType type)
```
    Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    Parameters:
    
    type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RxNormEntityType
  - setScore
```
public void setScore(Float score)
```
    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
    
    Parameters:
    
    score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
  - getScore
```
public Float getScore()
```
    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
    
    Returns:
    
    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
  - withScore
```
public RxNormEntity withScore(Float score)
```
    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
    
    Parameters:
    
    score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBeginOffset
```
public void setBeginOffset(Integer 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.
    
    Parameters:
    
    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.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    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.
    
    Returns:
    
    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.
  - withBeginOffset
```
public RxNormEntity withBeginOffset(Integer 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndOffset
```
public void setEndOffset(Integer 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.
    
    Parameters:
    
    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.
  - getEndOffset
```
public Integer getEndOffset()
```
    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.
    
    Returns:
    
    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.
  - withEndOffset
```
public RxNormEntity withEndOffset(Integer 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public List<RxNormAttribute> getAttributes()
```
    The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.
    
    Returns:
    
    The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.
  - setAttributes
```
public void setAttributes(Collection<RxNormAttribute> 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.
    
    Parameters:
    
    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.
  - withAttributes
```
public RxNormEntity withAttributes(RxNormAttribute... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributes
```
public RxNormEntity withAttributes(Collection<RxNormAttribute> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTraits
```
public List<RxNormTrait> getTraits()
```
    Contextual information for the entity.
    
    Returns:
    
    Contextual information for the entity.
  - setTraits
```
public void setTraits(Collection<RxNormTrait> traits)
```
    Contextual information for the entity.
    
    Parameters:
    
    traits - Contextual information for the entity.
  - withTraits
```
public RxNormEntity withTraits(RxNormTrait... traits)
```
    Contextual information for the entity.
    
    NOTE: This method appends the values to the existing list (if any). Use setTraits(java.util.Collection) or withTraits(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    traits - Contextual information for the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTraits
```
public RxNormEntity withTraits(Collection<RxNormTrait> traits)
```
    Contextual information for the entity.
    
    Parameters:
    
    traits - Contextual information for the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRxNormConcepts
```
public List<RxNormConcept> getRxNormConcepts()
```
    The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Returns:
    
    The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
  - setRxNormConcepts
```
public void setRxNormConcepts(Collection<RxNormConcept> rxNormConcepts)
```
    The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Parameters:
    
    rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
  - withRxNormConcepts
```
public RxNormEntity withRxNormConcepts(RxNormConcept... rxNormConcepts)
```
    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 setRxNormConcepts(java.util.Collection) or withRxNormConcepts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRxNormConcepts
```
public RxNormEntity withRxNormConcepts(Collection<RxNormConcept> rxNormConcepts)
```
    The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Parameters:
    
    rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RxNormEntity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class RxNormEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RxNormEntity

Method Detail

setId

getId

withId

setText

getText

withText

setCategory

getCategory

withCategory

withCategory

setType

getType

withType

withType

setScore

getScore

withScore

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

getAttributes

setAttributes

withAttributes

withAttributes

getTraits

setTraits

withTraits

withTraits

getRxNormConcepts

setRxNormConcepts

withRxNormConcepts

withRxNormConcepts

toString

equals

hashCode

clone

marshall