RxNormAttribute (AWS Java SDK for AWS Comprehend Medical 1.11.697 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RxNormAttribute
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RxNormAttribute()

Constructors
Constructor and Description
`RxNormAttribute()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RxNormAttribute`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBeginOffset()` The 0-based character offset in the input text that shows where the attribute begins.
`Integer`	`getEndOffset()` The 0-based character offset in the input text that shows where the attribute ends.
`Integer`	`getId()` The numeric identifier for this attribute.
`Float`	`getRelationshipScore()` The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
`Float`	`getScore()` The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`String`	`getText()` The segment of input text which corresponds to the detected attribute.
`List<RxNormTrait>`	`getTraits()` Contextual information for the attribute.
`String`	`getType()` The type of attribute.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the attribute begins.
`void`	`setEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the attribute ends.
`void`	`setId(Integer id)` The numeric identifier for this attribute.
`void`	`setRelationshipScore(Float relationshipScore)` The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
`void`	`setScore(Float score)` The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`void`	`setText(String text)` The segment of input text which corresponds to the detected attribute.
`void`	`setTraits(Collection<RxNormTrait> traits)` Contextual information for the attribute.
`void`	`setType(String type)` The type of attribute.
`String`	`toString()` Returns a string representation of this object.
`RxNormAttribute`	`withBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the attribute begins.
`RxNormAttribute`	`withEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the attribute ends.
`RxNormAttribute`	`withId(Integer id)` The numeric identifier for this attribute.
`RxNormAttribute`	`withRelationshipScore(Float relationshipScore)` The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
`RxNormAttribute`	`withScore(Float score)` The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
`RxNormAttribute`	`withText(String text)` The segment of input text which corresponds to the detected attribute.
`RxNormAttribute`	`withTraits(Collection<RxNormTrait> traits)` Contextual information for the attribute.
`RxNormAttribute`	`withTraits(RxNormTrait... traits)` Contextual information for the attribute.
`RxNormAttribute`	`withType(RxNormAttributeType type)` The type of attribute.
`RxNormAttribute`	`withType(String type)` The type of attribute.

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

- Constructor Detail
  - RxNormAttribute
```
public RxNormAttribute()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    Parameters:
    
    type - The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    See Also:
    
    RxNormAttributeType
  - getType
```
public String getType()
```
    The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    Returns:
    
    The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    See Also:
    
    RxNormAttributeType
  - withType
```
public RxNormAttribute withType(String type)
```
    The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    Parameters:
    
    type - The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RxNormAttributeType
  - withType
```
public RxNormAttribute withType(RxNormAttributeType type)
```
    The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    Parameters:
    
    type - The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RxNormAttributeType
  - setScore
```
public void setScore(Float score)
```
    The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
    
    Parameters:
    
    score - The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
  - getScore
```
public Float getScore()
```
    The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
    
    Returns:
    
    The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
  - withScore
```
public RxNormAttribute withScore(Float score)
```
    The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
    
    Parameters:
    
    score - The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRelationshipScore
```
public void setRelationshipScore(Float relationshipScore)
```
    The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
    
    Parameters:
    
    relationshipScore - The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
  - getRelationshipScore
```
public Float getRelationshipScore()
```
    The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
    
    Returns:
    
    The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
  - withRelationshipScore
```
public RxNormAttribute withRelationshipScore(Float relationshipScore)
```
    The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
    
    Parameters:
    
    relationshipScore - The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(Integer id)
```
    The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Parameters:
    
    id - The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - getId
```
public Integer getId()
```
    The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Returns:
    
    The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - withId
```
public RxNormAttribute withId(Integer id)
```
    The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Parameters:
    
    id - The numeric identifier for this attribute. 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.
  - setBeginOffset
```
public void setBeginOffset(Integer beginOffset)
```
    The 0-based character offset in the input text that shows where the attribute 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 attribute 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 attribute 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 attribute begins. The offset returns the UTF-8 code point in the string.
  - withBeginOffset
```
public RxNormAttribute withBeginOffset(Integer beginOffset)
```
    The 0-based character offset in the input text that shows where the attribute 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 attribute 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 attribute 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 attribute 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 attribute 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 attribute ends. The offset returns the UTF-8 code point in the string.
  - withEndOffset
```
public RxNormAttribute withEndOffset(Integer endOffset)
```
    The 0-based character offset in the input text that shows where the attribute 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 attribute 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.
  - setText
```
public void setText(String text)
```
    The segment of input text which corresponds to the detected attribute.
    
    Parameters:
    
    text - The segment of input text which corresponds to the detected attribute.
  - getText
```
public String getText()
```
    The segment of input text which corresponds to the detected attribute.
    
    Returns:
    
    The segment of input text which corresponds to the detected attribute.
  - withText
```
public RxNormAttribute withText(String text)
```
    The segment of input text which corresponds to the detected attribute.
    
    Parameters:
    
    text - The segment of input text which corresponds to the detected attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTraits
```
public List<RxNormTrait> getTraits()
```
    Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
    
    Returns:
    
    Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
  - setTraits
```
public void setTraits(Collection<RxNormTrait> traits)
```
    Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
    
    Parameters:
    
    traits - Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
  - withTraits
```
public RxNormAttribute withTraits(RxNormTrait... traits)
```
    Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
    
    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 attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTraits
```
public RxNormAttribute withTraits(Collection<RxNormTrait> traits)
```
    Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
    
    Parameters:
    
    traits - Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
    
    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 RxNormAttribute clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class RxNormAttribute

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RxNormAttribute

Method Detail

setType

getType

withType

withType

setScore

getScore

withScore

setRelationshipScore

getRelationshipScore

withRelationshipScore

setId

getId

withId

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

setText

getText

withText

getTraits

setTraits

withTraits

withTraits

toString

equals

hashCode

clone

marshall