org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class ColumnAnalysisSummary

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.ColumnAnalysisSummary

public class ColumnAnalysisSummary
extends Reference

POJO for the column_analysis_summary asset type in IGC, displayed as 'Column Analysis Summary' in the IGC UI.

(this code has been created 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 Boolean	allowNullValues
protected DataItem	analyzedColumn
protected ItemList<Term>	assignedToTerms
protected String	averageLength
protected Boolean	constant
protected String	domainType
protected String	inferredDataType Valid values are: INT8 (displayed in the UI as 'INT8') INT16 (displayed in the UI as 'INT16') INT32 (displayed in the UI as 'INT32') INT64 (displayed in the UI as 'INT64') SFLOAT (displayed in the UI as 'SFLOAT') DFLOAT (displayed in the UI as 'DFLOAT') QFLOAT (displayed in the UI as 'QFLOAT') DECIMAL (displayed in the UI as 'DECIMAL') STRING (displayed in the UI as 'STRING') BINARY (displayed in the UI as 'BINARY') BOOLEAN (displayed in the UI as 'BOOLEAN') DATE (displayed in the UI as 'DATE') TIME (displayed in the UI as 'TIME') DATETIME (displayed in the UI as 'DATETIME') DURATION (displayed in the UI as 'DURATION') CHOICE (displayed in the UI as 'CHOICE') ORDERED_GROUP (displayed in the UI as 'ORDERED_GROUP') UNORDERED_GROUP (displayed in the UI as 'UNORDERED_GROUP') GUID (displayed in the UI as 'GUID') UNKNOWN (displayed in the UI as 'UNKNOWN') JSON (displayed in the UI as 'JSON') XML (displayed in the UI as 'XML')
protected String	inferredFormat
protected Number	inferredLength
protected Number	inferredPrecision
protected Number	inferredScale
protected String	longDescription
protected String	longestLength
protected String	mask
protected String	nativeId
protected Number	numberOfCompleteValues
protected Number	numberOfDistinctFormats
protected Number	numberOfDistinctPatterns
protected Number	numberOfDistinctValues
protected Number	numberOfEmptyValues
protected Number	numberOfNullValues
protected Number	numberOfValidValues
protected Number	numberValues
protected String	projectName
protected Steward	promotedByPrincipal
protected Boolean	requireUniqueValues
protected Date	reviewDate
protected Steward	reviewedByPrincipal
protected String	shortDescription
protected String	shortestLength
protected String	shortLongDescription
protected ItemList<Steward>	steward

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors

Constructor and Description
ColumnAnalysisSummary()

Method Summary

Modifier and Type	Method and Description
Boolean	getAllowNullValues() Retrieve the allow_null_values property (displayed as 'Allow Null Values') of the object.
DataItem	getAnalyzedColumn() Retrieve the analyzed_column property (displayed as 'Analyzed Column') of the object.
ItemList<Term>	getAssignedToTerms() Retrieve the assigned_to_terms property (displayed as 'Assigned to Terms') of the object.
String	getAverageLength() Retrieve the average_length property (displayed as 'Average Length') of the object.
Boolean	getConstant() Retrieve the constant property (displayed as 'Constant') of the object.
String	getDomainType() Retrieve the domain_type property (displayed as 'Domain Type') of the object.
String	getInferredDataType() Retrieve the inferred_data_type property (displayed as 'Inferred Data Type') of the object.
String	getInferredFormat() Retrieve the inferred_format property (displayed as 'Inferred Format') of the object.
Number	getInferredLength() Retrieve the inferred_length property (displayed as 'Inferred Length') of the object.
Number	getInferredPrecision() Retrieve the inferred_precision property (displayed as 'Inferred Precision') of the object.
Number	getInferredScale() Retrieve the inferred_scale property (displayed as 'Inferred Scale') of the object.
String	getLongDescription() Retrieve the long_description property (displayed as 'Long Description') of the object.
String	getLongestLength() Retrieve the longest_length property (displayed as 'Longest Length') of the object.
String	getMask() Retrieve the mask property (displayed as 'Mask') of the object.
String	getNativeId() Retrieve the native_id property (displayed as 'Native ID') of the object.
Number	getNumberOfCompleteValues() Retrieve the number_of_complete_values property (displayed as 'Number of Complete Values') of the object.
Number	getNumberOfDistinctFormats() Retrieve the number_of_distinct_formats property (displayed as 'Number of Distinct Formats') of the object.
Number	getNumberOfDistinctPatterns() Retrieve the number_of_distinct_patterns property (displayed as 'Number of Distinct Patterns') of the object.
Number	getNumberOfDistinctValues() Retrieve the number_of_distinct_values property (displayed as 'Number of Distinct Values') of the object.
Number	getNumberOfEmptyValues() Retrieve the number_of_empty_values property (displayed as 'Number of Empty Values') of the object.
Number	getNumberOfNullValues() Retrieve the number_of_null_values property (displayed as 'Number of Null Values') of the object.
Number	getNumberOfValidValues() Retrieve the number_of_valid_values property (displayed as 'Number of Valid Values') of the object.
Number	getNumberValues() Retrieve the number_values property (displayed as 'Number Values') of the object.
String	getProjectName() Retrieve the project_name property (displayed as 'Project Name') of the object.
Steward	getPromotedByPrincipal() Retrieve the promoted_by_principal property (displayed as 'Promoted By Principal') of the object.
Boolean	getRequireUniqueValues() Retrieve the require_unique_values property (displayed as 'Require Unique Values') of the object.
Date	getReviewDate() Retrieve the review_date property (displayed as 'Review Date') of the object.
Steward	getReviewedByPrincipal() Retrieve the reviewed_by_principal property (displayed as 'Reviewed By Principal') of the object.
String	getShortDescription() Retrieve the short_description property (displayed as 'Short Description') of the object.
String	getShortestLength() Retrieve the shortest_length property (displayed as 'Shortest Length') of the object.
String	getShortLongDescription() Retrieve the short_&_long_description property (displayed as 'Short & Long Description') of the object.
ItemList<Steward>	getSteward() Retrieve the steward property (displayed as 'Steward') of the object.
void	setAllowNullValues(Boolean allowNullValues) Set the allow_null_values property (displayed as Allow Null Values) of the object.
void	setAnalyzedColumn(DataItem analyzedColumn) Set the analyzed_column property (displayed as Analyzed Column) of the object.
void	setAssignedToTerms(ItemList<Term> assignedToTerms) Set the assigned_to_terms property (displayed as Assigned to Terms) of the object.
void	setAverageLength(String averageLength) Set the average_length property (displayed as Average Length) of the object.
void	setConstant(Boolean constant) Set the constant property (displayed as Constant) of the object.
void	setDomainType(String domainType) Set the domain_type property (displayed as Domain Type) of the object.
void	setInferredDataType(String inferredDataType) Set the inferred_data_type property (displayed as Inferred Data Type) of the object.
void	setInferredFormat(String inferredFormat) Set the inferred_format property (displayed as Inferred Format) of the object.
void	setInferredLength(Number inferredLength) Set the inferred_length property (displayed as Inferred Length) of the object.
void	setInferredPrecision(Number inferredPrecision) Set the inferred_precision property (displayed as Inferred Precision) of the object.
void	setInferredScale(Number inferredScale) Set the inferred_scale property (displayed as Inferred Scale) of the object.
void	setLongDescription(String longDescription) Set the long_description property (displayed as Long Description) of the object.
void	setLongestLength(String longestLength) Set the longest_length property (displayed as Longest Length) of the object.
void	setMask(String mask) Set the mask property (displayed as Mask) of the object.
void	setNativeId(String nativeId) Set the native_id property (displayed as Native ID) of the object.
void	setNumberOfCompleteValues(Number numberOfCompleteValues) Set the number_of_complete_values property (displayed as Number of Complete Values) of the object.
void	setNumberOfDistinctFormats(Number numberOfDistinctFormats) Set the number_of_distinct_formats property (displayed as Number of Distinct Formats) of the object.
void	setNumberOfDistinctPatterns(Number numberOfDistinctPatterns) Set the number_of_distinct_patterns property (displayed as Number of Distinct Patterns) of the object.
void	setNumberOfDistinctValues(Number numberOfDistinctValues) Set the number_of_distinct_values property (displayed as Number of Distinct Values) of the object.
void	setNumberOfEmptyValues(Number numberOfEmptyValues) Set the number_of_empty_values property (displayed as Number of Empty Values) of the object.
void	setNumberOfNullValues(Number numberOfNullValues) Set the number_of_null_values property (displayed as Number of Null Values) of the object.
void	setNumberOfValidValues(Number numberOfValidValues) Set the number_of_valid_values property (displayed as Number of Valid Values) of the object.
void	setNumberValues(Number numberValues) Set the number_values property (displayed as Number Values) of the object.
void	setProjectName(String projectName) Set the project_name property (displayed as Project Name) of the object.
void	setPromotedByPrincipal(Steward promotedByPrincipal) Set the promoted_by_principal property (displayed as Promoted By Principal) of the object.
void	setRequireUniqueValues(Boolean requireUniqueValues) Set the require_unique_values property (displayed as Require Unique Values) of the object.
void	setReviewDate(Date reviewDate) Set the review_date property (displayed as Review Date) of the object.
void	setReviewedByPrincipal(Steward reviewedByPrincipal) Set the reviewed_by_principal property (displayed as Reviewed By Principal) of the object.
void	setShortDescription(String shortDescription) Set the short_description property (displayed as Short Description) of the object.
void	setShortestLength(String shortestLength) Set the shortest_length property (displayed as Shortest Length) of the object.
void	setShortLongDescription(String shortLongDescription) Set the short_&_long_description property (displayed as Short & Long Description) of the object.
void	setSteward(ItemList<Steward> steward) Set the steward property (displayed as Steward) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getName, getNotes, getType, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

allowNullValues

protected Boolean allowNullValues

analyzedColumn

protected DataItem analyzedColumn

assignedToTerms

protected ItemList<Term> assignedToTerms

averageLength

protected String averageLength

constant

protected Boolean constant

domainType

protected String domainType

inferredDataType

protected String inferredDataType

Valid values are:

• INT8 (displayed in the UI as 'INT8')
• INT16 (displayed in the UI as 'INT16')
• INT32 (displayed in the UI as 'INT32')
• INT64 (displayed in the UI as 'INT64')
• SFLOAT (displayed in the UI as 'SFLOAT')
• DFLOAT (displayed in the UI as 'DFLOAT')
• QFLOAT (displayed in the UI as 'QFLOAT')
• DECIMAL (displayed in the UI as 'DECIMAL')
• STRING (displayed in the UI as 'STRING')
• BINARY (displayed in the UI as 'BINARY')
• BOOLEAN (displayed in the UI as 'BOOLEAN')
• DATE (displayed in the UI as 'DATE')
• TIME (displayed in the UI as 'TIME')
• DATETIME (displayed in the UI as 'DATETIME')
• DURATION (displayed in the UI as 'DURATION')
• CHOICE (displayed in the UI as 'CHOICE')
• ORDERED_GROUP (displayed in the UI as 'ORDERED_GROUP')
• UNORDERED_GROUP (displayed in the UI as 'UNORDERED_GROUP')
• GUID (displayed in the UI as 'GUID')
• UNKNOWN (displayed in the UI as 'UNKNOWN')
• JSON (displayed in the UI as 'JSON')
• XML (displayed in the UI as 'XML')

inferredFormat

protected String inferredFormat

inferredLength

protected Number inferredLength

inferredPrecision

protected Number inferredPrecision

inferredScale

protected Number inferredScale

longDescription

protected String longDescription

longestLength

protected String longestLength

mask

protected String mask

nativeId

protected String nativeId

numberOfCompleteValues

protected Number numberOfCompleteValues

numberOfDistinctFormats

protected Number numberOfDistinctFormats

numberOfDistinctPatterns

protected Number numberOfDistinctPatterns

numberOfDistinctValues

protected Number numberOfDistinctValues

numberOfEmptyValues

protected Number numberOfEmptyValues

numberOfNullValues

protected Number numberOfNullValues

numberOfValidValues

protected Number numberOfValidValues

numberValues

protected Number numberValues

projectName

protected String projectName

promotedByPrincipal

protected Steward promotedByPrincipal

requireUniqueValues

protected Boolean requireUniqueValues

reviewDate

protected Date reviewDate

reviewedByPrincipal

protected Steward reviewedByPrincipal

shortLongDescription

protected String shortLongDescription

shortDescription

protected String shortDescription

shortestLength

protected String shortestLength

steward

protected ItemList<Steward> steward

Constructor Detail

ColumnAnalysisSummary

public ColumnAnalysisSummary()

Method Detail

getAllowNullValues

public Boolean getAllowNullValues()

Retrieve the allow_null_values property (displayed as 'Allow Null Values') of the object.

Returns:

Boolean

setAllowNullValues

public void setAllowNullValues(Boolean allowNullValues)

Set the allow_null_values property (displayed as Allow Null Values) of the object.

Parameters:

allowNullValues - the value to set

getAnalyzedColumn

public DataItem getAnalyzedColumn()

Retrieve the analyzed_column property (displayed as 'Analyzed Column') of the object.

Returns:

DataItem

setAnalyzedColumn

public void setAnalyzedColumn(DataItem analyzedColumn)

Set the analyzed_column property (displayed as Analyzed Column) of the object.

Parameters:

analyzedColumn - the value to set

getAssignedToTerms

public ItemList<Term> getAssignedToTerms()

Retrieve the assigned_to_terms property (displayed as 'Assigned to Terms') of the object.

Returns:

ItemList<Term>

setAssignedToTerms

public void setAssignedToTerms(ItemList<Term> assignedToTerms)

Set the assigned_to_terms property (displayed as Assigned to Terms) of the object.

Parameters:

assignedToTerms - the value to set

getAverageLength

public String getAverageLength()

Retrieve the average_length property (displayed as 'Average Length') of the object.

Returns:

String

setAverageLength

public void setAverageLength(String averageLength)

Set the average_length property (displayed as Average Length) of the object.

Parameters:

averageLength - the value to set

getConstant

public Boolean getConstant()

Retrieve the constant property (displayed as 'Constant') of the object.

Returns:

Boolean

setConstant

public void setConstant(Boolean constant)

Set the constant property (displayed as Constant) of the object.

Parameters:

constant - the value to set

getDomainType

public String getDomainType()

Retrieve the domain_type property (displayed as 'Domain Type') of the object.

Returns:

String

setDomainType

public void setDomainType(String domainType)

Set the domain_type property (displayed as Domain Type) of the object.

Parameters:

domainType - the value to set

getInferredDataType

public String getInferredDataType()

Retrieve the inferred_data_type property (displayed as 'Inferred Data Type') of the object.

Returns:

String

setInferredDataType

public void setInferredDataType(String inferredDataType)

Set the inferred_data_type property (displayed as Inferred Data Type) of the object.

Parameters:

inferredDataType - the value to set

getInferredFormat

public String getInferredFormat()

Retrieve the inferred_format property (displayed as 'Inferred Format') of the object.

Returns:

String

setInferredFormat

public void setInferredFormat(String inferredFormat)

Set the inferred_format property (displayed as Inferred Format) of the object.

Parameters:

inferredFormat - the value to set

getInferredLength

public Number getInferredLength()

Retrieve the inferred_length property (displayed as 'Inferred Length') of the object.

Returns:

Number

setInferredLength

public void setInferredLength(Number inferredLength)

Set the inferred_length property (displayed as Inferred Length) of the object.

Parameters:

inferredLength - the value to set

getInferredPrecision

public Number getInferredPrecision()

Retrieve the inferred_precision property (displayed as 'Inferred Precision') of the object.

Returns:

Number

setInferredPrecision

public void setInferredPrecision(Number inferredPrecision)

Set the inferred_precision property (displayed as Inferred Precision) of the object.

Parameters:

inferredPrecision - the value to set

getInferredScale

public Number getInferredScale()

Retrieve the inferred_scale property (displayed as 'Inferred Scale') of the object.

Returns:

Number

setInferredScale

public void setInferredScale(Number inferredScale)

Set the inferred_scale property (displayed as Inferred Scale) of the object.

Parameters:

inferredScale - the value to set

getLongDescription

public String getLongDescription()

Retrieve the long_description property (displayed as 'Long Description') of the object.

Returns:

String

setLongDescription

public void setLongDescription(String longDescription)

Set the long_description property (displayed as Long Description) of the object.

Parameters:

longDescription - the value to set

getLongestLength

public String getLongestLength()

Retrieve the longest_length property (displayed as 'Longest Length') of the object.

Returns:

String

setLongestLength

public void setLongestLength(String longestLength)

Set the longest_length property (displayed as Longest Length) of the object.

Parameters:

longestLength - the value to set

getMask

public String getMask()

Retrieve the mask property (displayed as 'Mask') of the object.

Returns:

String

setMask

public void setMask(String mask)

Set the mask property (displayed as Mask) of the object.

Parameters:

mask - the value to set

getNativeId

public String getNativeId()

Retrieve the native_id property (displayed as 'Native ID') of the object.

Returns:

String

setNativeId

public void setNativeId(String nativeId)

Set the native_id property (displayed as Native ID) of the object.

Parameters:

nativeId - the value to set

getNumberOfCompleteValues

public Number getNumberOfCompleteValues()

Retrieve the number_of_complete_values property (displayed as 'Number of Complete Values') of the object.

Returns:

Number

setNumberOfCompleteValues

public void setNumberOfCompleteValues(Number numberOfCompleteValues)

Set the number_of_complete_values property (displayed as Number of Complete Values) of the object.

Parameters:

numberOfCompleteValues - the value to set

getNumberOfDistinctFormats

public Number getNumberOfDistinctFormats()

Retrieve the number_of_distinct_formats property (displayed as 'Number of Distinct Formats') of the object.

Returns:

Number

setNumberOfDistinctFormats

public void setNumberOfDistinctFormats(Number numberOfDistinctFormats)

Set the number_of_distinct_formats property (displayed as Number of Distinct Formats) of the object.

Parameters:

numberOfDistinctFormats - the value to set

getNumberOfDistinctPatterns

public Number getNumberOfDistinctPatterns()

Retrieve the number_of_distinct_patterns property (displayed as 'Number of Distinct Patterns') of the object.

Returns:

Number

setNumberOfDistinctPatterns

public void setNumberOfDistinctPatterns(Number numberOfDistinctPatterns)

Set the number_of_distinct_patterns property (displayed as Number of Distinct Patterns) of the object.

Parameters:

numberOfDistinctPatterns - the value to set

getNumberOfDistinctValues

public Number getNumberOfDistinctValues()

Retrieve the number_of_distinct_values property (displayed as 'Number of Distinct Values') of the object.

Returns:

Number

setNumberOfDistinctValues

public void setNumberOfDistinctValues(Number numberOfDistinctValues)

Set the number_of_distinct_values property (displayed as Number of Distinct Values) of the object.

Parameters:

numberOfDistinctValues - the value to set

getNumberOfEmptyValues

public Number getNumberOfEmptyValues()

Retrieve the number_of_empty_values property (displayed as 'Number of Empty Values') of the object.

Returns:

Number

setNumberOfEmptyValues

public void setNumberOfEmptyValues(Number numberOfEmptyValues)

Set the number_of_empty_values property (displayed as Number of Empty Values) of the object.

Parameters:

numberOfEmptyValues - the value to set

getNumberOfNullValues

public Number getNumberOfNullValues()

Retrieve the number_of_null_values property (displayed as 'Number of Null Values') of the object.

Returns:

Number

setNumberOfNullValues

public void setNumberOfNullValues(Number numberOfNullValues)

Set the number_of_null_values property (displayed as Number of Null Values) of the object.

Parameters:

numberOfNullValues - the value to set

getNumberOfValidValues

public Number getNumberOfValidValues()

Retrieve the number_of_valid_values property (displayed as 'Number of Valid Values') of the object.

Returns:

Number

setNumberOfValidValues

public void setNumberOfValidValues(Number numberOfValidValues)

Set the number_of_valid_values property (displayed as Number of Valid Values) of the object.

Parameters:

numberOfValidValues - the value to set

getNumberValues

public Number getNumberValues()

Retrieve the number_values property (displayed as 'Number Values') of the object.

Returns:

Number

setNumberValues

public void setNumberValues(Number numberValues)

Set the number_values property (displayed as Number Values) of the object.

Parameters:

numberValues - the value to set

getProjectName

public String getProjectName()

Retrieve the project_name property (displayed as 'Project Name') of the object.

Returns:

String

setProjectName

public void setProjectName(String projectName)

Set the project_name property (displayed as Project Name) of the object.

Parameters:

projectName - the value to set

getPromotedByPrincipal

public Steward getPromotedByPrincipal()

Retrieve the promoted_by_principal property (displayed as 'Promoted By Principal') of the object.

Returns:

Steward

setPromotedByPrincipal

public void setPromotedByPrincipal(Steward promotedByPrincipal)

Set the promoted_by_principal property (displayed as Promoted By Principal) of the object.

Parameters:

promotedByPrincipal - the value to set

getRequireUniqueValues

public Boolean getRequireUniqueValues()

Retrieve the require_unique_values property (displayed as 'Require Unique Values') of the object.

Returns:

Boolean

setRequireUniqueValues

public void setRequireUniqueValues(Boolean requireUniqueValues)

Set the require_unique_values property (displayed as Require Unique Values) of the object.

Parameters:

requireUniqueValues - the value to set

getReviewDate

public Date getReviewDate()

Retrieve the review_date property (displayed as 'Review Date') of the object.

Returns:

Date

setReviewDate

public void setReviewDate(Date reviewDate)

Set the review_date property (displayed as Review Date) of the object.

Parameters:

reviewDate - the value to set

getReviewedByPrincipal

public Steward getReviewedByPrincipal()

Retrieve the reviewed_by_principal property (displayed as 'Reviewed By Principal') of the object.

Returns:

Steward

setReviewedByPrincipal

public void setReviewedByPrincipal(Steward reviewedByPrincipal)

Set the reviewed_by_principal property (displayed as Reviewed By Principal) of the object.

Parameters:

reviewedByPrincipal - the value to set

getShortLongDescription

public String getShortLongDescription()

Retrieve the short_&_long_description property (displayed as 'Short & Long Description') of the object.

Returns:

String

setShortLongDescription

public void setShortLongDescription(String shortLongDescription)

Set the short_&_long_description property (displayed as Short & Long Description) of the object.

Parameters:

shortLongDescription - the value to set

getShortDescription

public String getShortDescription()

Retrieve the short_description property (displayed as 'Short Description') of the object.

Returns:

String

setShortDescription

public void setShortDescription(String shortDescription)

Set the short_description property (displayed as Short Description) of the object.

Parameters:

shortDescription - the value to set

getShortestLength

public String getShortestLength()

Retrieve the shortest_length property (displayed as 'Shortest Length') of the object.

Returns:

String

setShortestLength

public void setShortestLength(String shortestLength)

Set the shortest_length property (displayed as Shortest Length) of the object.

Parameters:

shortestLength - the value to set

getSteward

public ItemList<Steward> getSteward()

Retrieve the steward property (displayed as 'Steward') of the object.

Returns:

ItemList<Steward>

setSteward

public void setSteward(ItemList<Steward> steward)

Set the steward property (displayed as Steward) of the object.

Parameters:

steward - the value to set