TableAnalysisSummary (IBM Information Governance Catalog REST API Client Library 1.0 API)

java.lang.Object
- org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
  - - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.generated.v11501.TableAnalysisSummary

```
public class TableAnalysisSummary
extends Reference
```
POJO for the table_analysis_summary asset type in IGC, displayed as 'Table Analysis Summary' in the IGC UI.

(this code has been generated based on out-of-the-box IGC metadata types; if modifications are needed, eg. to handle custom attributes, extending from this class in your own custom class is the best approach.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`analyzed_table` The `analyzed_table` property, displayed as 'Analyzed Table' in the IGC UI.
`protected ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected String`	`created_by` The `created_by` property, displayed as 'Created By' in the IGC UI.
`protected Date`	`created_on` The `created_on` property, displayed as 'Created On' in the IGC UI.
`protected Number`	`foreign_key_violations` The `foreign_key_violations` property, displayed as 'Foreign Key Violations' in the IGC UI.
`protected String`	`inferred_foreign_keys` The `inferred_foreign_keys` property, displayed as 'Inferred Foreign Keys' in the IGC UI.
`protected String`	`inferred_primary_keys` The `inferred_primary_keys` property, displayed as 'Inferred Primary Keys' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected String`	`modified_by` The `modified_by` property, displayed as 'Modified By' in the IGC UI.
`protected Date`	`modified_on` The `modified_on` property, displayed as 'Modified On' in the IGC UI.
`protected Number`	`number_of_fields` The `number_of_fields` property, displayed as 'Number of Fields' in the IGC UI.
`protected Number`	`number_of_rows` The `number_of_rows` property, displayed as 'Number of Rows' in the IGC UI.
`protected Number`	`primary_key_duplicates` The `primary_key_duplicates` property, displayed as 'Primary Key Duplicates' in the IGC UI.
`protected String`	`project_name` The `project_name` property, displayed as 'Analysis Project' in the IGC UI.
`protected Reference`	`promoted_by_principal` The `promoted_by_principal` property, displayed as 'Promoted By Principal' in the IGC UI.
`protected Date`	`review_date` The `review_date` property, displayed as 'Review Date' in the IGC UI.
`protected Reference`	`reviewed_by_principal` The `reviewed_by_principal` property, displayed as 'Reviewed By Principal' in the IGC UI.
`protected String`	`short___long_description` The `short_&_long_description` property, displayed as 'Short & Long Description' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected ReferenceList`	`steward` The `steward` property, displayed as 'Steward' in the IGC UI.

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url

Constructor Summary

Constructors
Constructor and Description

TableAnalysisSummary()

Constructors
Constructor and Description
`TableAnalysisSummary()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`Reference`	`getAnalyzedTable()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`Number`	`getForeignKeyViolations()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`String`	`getInferredForeignKeys()`
`String`	`getInferredPrimaryKeys()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`Number`	`getNumberOfFields()`
`Number`	`getNumberOfRows()`
`static List<String>`	`getPagedRelationshipProperties()`
`Number`	`getPrimaryKeyDuplicates()`
`String`	`getProjectName()`
`Reference`	`getPromotedByPrincipal()`
`Date`	`getReviewDate()`
`Reference`	`getReviewedByPrincipal()`
`String`	`getShortDescription()`
`String`	`getShortLongDescription()`
`ReferenceList`	`getSteward()`
`static List<String>`	`getStringProperties()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isTableAnalysisSummary(Object obj)`
`void`	`setAnalyzedTable(Reference analyzed_table)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setForeignKeyViolations(Number foreign_key_violations)`
`void`	`setInferredForeignKeys(String inferred_foreign_keys)`
`void`	`setInferredPrimaryKeys(String inferred_primary_keys)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setNumberOfFields(Number number_of_fields)`
`void`	`setNumberOfRows(Number number_of_rows)`
`void`	`setPrimaryKeyDuplicates(Number primary_key_duplicates)`
`void`	`setProjectName(String project_name)`
`void`	`setPromotedByPrincipal(Reference promoted_by_principal)`
`void`	`setReviewDate(Date review_date)`
`void`	`setReviewedByPrincipal(Reference reviewed_by_principal)`
`void`	`setShortDescription(String short_description)`
`void`	`setShortLongDescription(String short___long_description)`
`void`	`setSteward(ReferenceList steward)`

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
canAssetBeCreatedFromPOJO, getAllPropertiesFromPOJO, getAssetDetails, getAssetTypeForSearch, getAssetTypeFromPOJO, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getContext, getDisplayNameFromPOJO, getFieldByName, getFullAssetDetails, getId, getIdentity, getName, getNonRelationshipPropertiesFromPOJO, getPagedRelationalPropertiesFromPOJO, getPropertyByName, getStringPropertiesFromPOJO, getType, getUrl, hasModificationDetails, hasModificationDetails, hasProperty, isCreatableFromPOJO, isFullyRetrieved, isReference, isReference, isReferenceList, isReferenceList, isSimpleType, isSimpleType, populateContext, populateModificationDetails, setContext, setFullyRetrieved, setId, setName, setPropertyByName, setType, setUrl

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
getAllFields, toString

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

- Field Detail
  - short___long_description
```
protected String short___long_description
```
    The short_&_long_description property, displayed as 'Short & Long Description' in the IGC UI.
  - short_description
```
protected String short_description
```
    The short_description property, displayed as 'Short Description' in the IGC UI.
  - long_description
```
protected String long_description
```
    The long_description property, displayed as 'Long Description' in the IGC UI.
  - assigned_to_terms
```
protected ReferenceList assigned_to_terms
```
    The assigned_to_terms property, displayed as 'Assigned to Terms' in the IGC UI.
    
    Will be a ReferenceList of Term objects.
  - steward
```
protected ReferenceList steward
```
    The steward property, displayed as 'Steward' in the IGC UI.
    
    Will be a ReferenceList of Steward objects.
  - analyzed_table
```
protected Reference analyzed_table
```
    The analyzed_table property, displayed as 'Analyzed Table' in the IGC UI.
    
    Will be a single Reference to a Datagroup object.
  - project_name
```
protected String project_name
```
    The project_name property, displayed as 'Analysis Project' in the IGC UI.
  - review_date
```
protected Date review_date
```
    The review_date property, displayed as 'Review Date' in the IGC UI.
  - promoted_by_principal
```
protected Reference promoted_by_principal
```
    The promoted_by_principal property, displayed as 'Promoted By Principal' in the IGC UI.
    
    Will be a single Reference to a Steward object.
  - reviewed_by_principal
```
protected Reference reviewed_by_principal
```
    The reviewed_by_principal property, displayed as 'Reviewed By Principal' in the IGC UI.
    
    Will be a single Reference to a Steward object.
  - created_by
```
protected String created_by
```
    The created_by property, displayed as 'Created By' in the IGC UI.
  - created_on
```
protected Date created_on
```
    The created_on property, displayed as 'Created On' in the IGC UI.
  - modified_by
```
protected String modified_by
```
    The modified_by property, displayed as 'Modified By' in the IGC UI.
  - modified_on
```
protected Date modified_on
```
    The modified_on property, displayed as 'Modified On' in the IGC UI.
  - number_of_fields
```
protected Number number_of_fields
```
    The number_of_fields property, displayed as 'Number of Fields' in the IGC UI.
  - number_of_rows
```
protected Number number_of_rows
```
    The number_of_rows property, displayed as 'Number of Rows' in the IGC UI.
  - inferred_primary_keys
```
protected String inferred_primary_keys
```
    The inferred_primary_keys property, displayed as 'Inferred Primary Keys' in the IGC UI.
  - primary_key_duplicates
```
protected Number primary_key_duplicates
```
    The primary_key_duplicates property, displayed as 'Primary Key Duplicates' in the IGC UI.
  - inferred_foreign_keys
```
protected String inferred_foreign_keys
```
    The inferred_foreign_keys property, displayed as 'Inferred Foreign Keys' in the IGC UI.
  - foreign_key_violations
```
protected Number foreign_key_violations
```
    The foreign_key_violations property, displayed as 'Foreign Key Violations' in the IGC UI.
- Constructor Detail
  - TableAnalysisSummary
```
public TableAnalysisSummary()
```
- Method Detail
  - getIgcTypeId
```
public static String getIgcTypeId()
```
  - getIgcTypeDisplayName
```
public static String getIgcTypeDisplayName()
```
  - getShortLongDescription
```
public String getShortLongDescription()
```
    See Also:
    
    short___long_description
  - setShortLongDescription
```
public void setShortLongDescription(String short___long_description)
```
    See Also:
    
    short___long_description
  - getShortDescription
```
public String getShortDescription()
```
    See Also:
    
    short_description
  - setShortDescription
```
public void setShortDescription(String short_description)
```
    See Also:
    
    short_description
  - getLongDescription
```
public String getLongDescription()
```
    See Also:
    
    long_description
  - setLongDescription
```
public void setLongDescription(String long_description)
```
    See Also:
    
    long_description
  - getAssignedToTerms
```
public ReferenceList getAssignedToTerms()
```
    See Also:
    
    assigned_to_terms
  - setAssignedToTerms
```
public void setAssignedToTerms(ReferenceList assigned_to_terms)
```
    See Also:
    
    assigned_to_terms
  - getSteward
```
public ReferenceList getSteward()
```
    See Also:
    
    steward
  - setSteward
```
public void setSteward(ReferenceList steward)
```
    See Also:
    
    steward
  - getAnalyzedTable
```
public Reference getAnalyzedTable()
```
    See Also:
    
    analyzed_table
  - setAnalyzedTable
```
public void setAnalyzedTable(Reference analyzed_table)
```
    See Also:
    
    analyzed_table
  - getProjectName
```
public String getProjectName()
```
    See Also:
    
    project_name
  - setProjectName
```
public void setProjectName(String project_name)
```
    See Also:
    
    project_name
  - getReviewDate
```
public Date getReviewDate()
```
    See Also:
    
    review_date
  - setReviewDate
```
public void setReviewDate(Date review_date)
```
    See Also:
    
    review_date
  - getPromotedByPrincipal
```
public Reference getPromotedByPrincipal()
```
    See Also:
    
    promoted_by_principal
  - setPromotedByPrincipal
```
public void setPromotedByPrincipal(Reference promoted_by_principal)
```
    See Also:
    
    promoted_by_principal
  - getReviewedByPrincipal
```
public Reference getReviewedByPrincipal()
```
    See Also:
    
    reviewed_by_principal
  - setReviewedByPrincipal
```
public void setReviewedByPrincipal(Reference reviewed_by_principal)
```
    See Also:
    
    reviewed_by_principal
  - getCreatedBy
```
public String getCreatedBy()
```
    See Also:
    
    created_by
  - setCreatedBy
```
public void setCreatedBy(String created_by)
```
    See Also:
    
    created_by
  - getCreatedOn
```
public Date getCreatedOn()
```
    See Also:
    
    created_on
  - setCreatedOn
```
public void setCreatedOn(Date created_on)
```
    See Also:
    
    created_on
  - getModifiedBy
```
public String getModifiedBy()
```
    See Also:
    
    modified_by
  - setModifiedBy
```
public void setModifiedBy(String modified_by)
```
    See Also:
    
    modified_by
  - getModifiedOn
```
public Date getModifiedOn()
```
    See Also:
    
    modified_on
  - setModifiedOn
```
public void setModifiedOn(Date modified_on)
```
    See Also:
    
    modified_on
  - getNumberOfFields
```
public Number getNumberOfFields()
```
    See Also:
    
    number_of_fields
  - setNumberOfFields
```
public void setNumberOfFields(Number number_of_fields)
```
    See Also:
    
    number_of_fields
  - getNumberOfRows
```
public Number getNumberOfRows()
```
    See Also:
    
    number_of_rows
  - setNumberOfRows
```
public void setNumberOfRows(Number number_of_rows)
```
    See Also:
    
    number_of_rows
  - getInferredPrimaryKeys
```
public String getInferredPrimaryKeys()
```
    See Also:
    
    inferred_primary_keys
  - setInferredPrimaryKeys
```
public void setInferredPrimaryKeys(String inferred_primary_keys)
```
    See Also:
    
    inferred_primary_keys
  - getPrimaryKeyDuplicates
```
public Number getPrimaryKeyDuplicates()
```
    See Also:
    
    primary_key_duplicates
  - setPrimaryKeyDuplicates
```
public void setPrimaryKeyDuplicates(Number primary_key_duplicates)
```
    See Also:
    
    primary_key_duplicates
  - getInferredForeignKeys
```
public String getInferredForeignKeys()
```
    See Also:
    
    inferred_foreign_keys
  - setInferredForeignKeys
```
public void setInferredForeignKeys(String inferred_foreign_keys)
```
    See Also:
    
    inferred_foreign_keys
  - getForeignKeyViolations
```
public Number getForeignKeyViolations()
```
    See Also:
    
    foreign_key_violations
  - setForeignKeyViolations
```
public void setForeignKeyViolations(Number foreign_key_violations)
```
    See Also:
    
    foreign_key_violations
  - canBeCreated
```
public static Boolean canBeCreated()
```
  - includesModificationDetails
```
public static Boolean includesModificationDetails()
```
  - getNonRelationshipProperties
```
public static List<String> getNonRelationshipProperties()
```
  - getStringProperties
```
public static List<String> getStringProperties()
```
  - getPagedRelationshipProperties
```
public static List<String> getPagedRelationshipProperties()
```
  - getAllProperties
```
public static List<String> getAllProperties()
```
  - isTableAnalysisSummary
```
public static Boolean isTableAnalysisSummary(Object obj)
```

Class TableAnalysisSummary

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

short___long_description

short_description

long_description

assigned_to_terms

steward

analyzed_table

project_name

review_date

promoted_by_principal

reviewed_by_principal

created_by

created_on

modified_by

modified_on

number_of_fields

number_of_rows

inferred_primary_keys

primary_key_duplicates

inferred_foreign_keys

foreign_key_violations

Constructor Detail

TableAnalysisSummary

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getShortLongDescription

setShortLongDescription

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getAssignedToTerms

setAssignedToTerms

getSteward

setSteward

getAnalyzedTable

setAnalyzedTable

getProjectName

setProjectName

getReviewDate

setReviewDate

getPromotedByPrincipal

setPromotedByPrincipal

getReviewedByPrincipal

setReviewedByPrincipal

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

getNumberOfFields

setNumberOfFields

getNumberOfRows

setNumberOfRows

getInferredPrimaryKeys

setInferredPrimaryKeys

getPrimaryKeyDuplicates

setPrimaryKeyDuplicates

getInferredForeignKeys

setInferredForeignKeys

getForeignKeyViolations

setForeignKeyViolations

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties