I2b2Concept (i2b2 Client 2.2 API)

java.lang.Object
- org.eurekaclinical.i2b2.client.comm.I2b2Concept

```
public final class I2b2Concept
extends Object
```
A JPA entity representing an i2b2 concept.

Since:

1.0

Author:

Michel Mansour

Constructor Summary

Constructors
Constructor and Description
`I2b2Concept()` Default no-arg constructor.
`I2b2Concept(String key, Integer level, String tableName, String dimensionCode, String isSynonym)` Constructs an i2b2 concept from required fields.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getColumnDataType()`
`String`	`getColumnName()` Gets the concept column name.
`String`	`getDimensionCode()` Gets the i2b2 concept's dimension code.
`String`	`getDisplayName()` Gets the display name for the concept.
`String`	`getFactTableColumn()`
`String`	`getHasChildren()` Gets whether this concept has children.
`String`	`getI2b2Key()` Gets the i2b2 key.
`String`	`getIcd9()` Gets the concept's ICD-9 form.
`Long`	`getId()` Gets the JPA entity's ID
`String`	`getIsSynonym()` Gets the i2b2 concept's synonym code.
`int`	`getLevel()` Gets the i2b2 concept's level in the hierarchy.
`String`	`getName()` Gets the concept name.
`String`	`getOperator()` Gets the operator.
`String`	`getTableName()` Gets the i2b2 concept's table name.
`String`	`getTooltip()` Gets the concept's tooltip.
`String`	`getXmlOrig()` Gets the original XML of the concept.
`int`	`hashCode()`
`void`	`setColumnName(String columnName)` Sets the column name.
`void`	`setDimensionCode(String dimensionCode)` Sets the dimension code.
`void`	`setDisplayName(String displayName)` Sets the display name.
`void`	`setHasChildren(String hasChildren)` Sets the has children property.
`void`	`setI2b2Key(String i2b2Key)` Sets the i2b2 key.
`void`	`setIcd9(String icd9)` Sets the concept's ICD-9 string.
`void`	`setId(Long id)`
`void`	`setIsSynonym(String isSynonym)` Sets the synonym code.
`void`	`setLevel(Integer level)` Sets the level.
`void`	`setName(String name)` Sets the name
`void`	`setOperator(String operator)` Sets the operator.
`void`	`setTableName(String tableName)` Sets the table name.
`void`	`setTooltip(String tooltip)` Sets the tooltip.
`void`	`setXmlOrig(String xmlOrig)` Sets the original XML.
`String`	`toString()`

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

- Constructor Detail
  - I2b2Concept
```
public I2b2Concept()
```
    Default no-arg constructor. Sets all fields to null. Modifiers should be called immediately after.
  - I2b2Concept
```
public I2b2Concept(String key,
                   Integer level,
                   String tableName,
                   String dimensionCode,
                   String isSynonym)
```
    Constructs an i2b2 concept from required fields.
    
    Parameters:
    
    key - the concept key
    
    level - the concept's level in the hierarchy
    
    tableName - the concept's table name
    
    dimensionCode - the concept's dimension code
    
    isSynonym - the concept's synonym code
- Method Detail
  - getId
```
public Long getId()
```
    Gets the JPA entity's ID
    
    Returns:
    
    the id
  - getI2b2Key
```
public String getI2b2Key()
```
    Gets the i2b2 key.
    
    Returns:
    
    the i2b2 key
  - getLevel
```
public int getLevel()
```
    Gets the i2b2 concept's level in the hierarchy.
    
    Returns:
    
    the level
  - getTableName
```
public String getTableName()
```
    Gets the i2b2 concept's table name.
    
    Returns:
    
    the table name
  - getDimensionCode
```
public String getDimensionCode()
```
    Gets the i2b2 concept's dimension code.
    
    Returns:
    
    the dimension code
  - getIsSynonym
```
public String getIsSynonym()
```
    Gets the i2b2 concept's synonym code.
    
    Returns:
    
    the synonym code
  - setI2b2Key
```
public void setI2b2Key(String i2b2Key)
```
    Sets the i2b2 key.
    
    Parameters:
    
    i2b2Key - the i2b2 key
  - setLevel
```
public void setLevel(Integer level)
```
    Sets the level.
    
    Parameters:
    
    level - the level
  - setTableName
```
public void setTableName(String tableName)
```
    Sets the table name.
    
    Parameters:
    
    tableName - the table name
  - setDimensionCode
```
public void setDimensionCode(String dimensionCode)
```
    Sets the dimension code.
    
    Parameters:
    
    dimensionCode - the dimension code
  - setIsSynonym
```
public void setIsSynonym(String isSynonym)
```
    Sets the synonym code.
    
    Parameters:
    
    isSynonym - the synonym code
  - getName
```
public String getName()
```
    Gets the concept name.
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Sets the name
    
    Parameters:
    
    name - the name
  - getColumnName
```
public String getColumnName()
```
    Gets the concept column name.
    
    Returns:
    
    the column name
  - setId
```
public void setId(Long id)
```
  - setColumnName
```
public void setColumnName(String columnName)
```
    Sets the column name.
    
    Parameters:
    
    columnName - the column name
  - getOperator
```
public String getOperator()
```
    Gets the operator.
    
    Returns:
    
    the operator
  - setOperator
```
public void setOperator(String operator)
```
    Sets the operator.
    
    Parameters:
    
    operator - the operator
  - getDisplayName
```
public String getDisplayName()
```
    Gets the display name for the concept.
    
    Returns:
    
    the display name
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the display name.
    
    Parameters:
    
    displayName - the display name
  - getTooltip
```
public String getTooltip()
```
    Gets the concept's tooltip.
    
    Returns:
    
    the tooltip
  - setTooltip
```
public void setTooltip(String tooltip)
```
    Sets the tooltip.
    
    Parameters:
    
    tooltip - the tooltip
  - getHasChildren
```
public String getHasChildren()
```
    Gets whether this concept has children.
    
    Returns:
    
    whether it has children
  - setHasChildren
```
public void setHasChildren(String hasChildren)
```
    Sets the has children property.
    
    Parameters:
    
    hasChildren - whether it has children
  - getIcd9
```
public String getIcd9()
```
    Gets the concept's ICD-9 form.
    
    Returns:
    
    the ICD-9 string
  - setIcd9
```
public void setIcd9(String icd9)
```
    Sets the concept's ICD-9 string.
    
    Parameters:
    
    icd9 - the ICD-9 string
  - getXmlOrig
```
public String getXmlOrig()
```
    Gets the original XML of the concept.
    
    Returns:
    
    the original XML
  - setXmlOrig
```
public void setXmlOrig(String xmlOrig)
```
    Sets the original XML.
    
    Parameters:
    
    xmlOrig - the original XML
  - getColumnDataType
```
public String getColumnDataType()
```
  - getFactTableColumn
```
public String getFactTableColumn()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class I2b2Concept

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

I2b2Concept

I2b2Concept

Method Detail

getId

getI2b2Key

getLevel

getTableName

getDimensionCode

getIsSynonym

setI2b2Key

setLevel

setTableName

setDimensionCode

setIsSynonym

getName

setName

getColumnName

setId

setColumnName

getOperator

setOperator

getDisplayName

setDisplayName

getTooltip

setTooltip

getHasChildren

setHasChildren

getIcd9

setIcd9

getXmlOrig

setXmlOrig

getColumnDataType

getFactTableColumn

hashCode

equals

toString