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

Class DatabaseIndex

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.DatabaseIndex

public class DatabaseIndex
extends Reference

POJO for the database_index asset type in IGC, displayed as 'Database Index' 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 List<String>	expression
protected Boolean	function
protected ItemList<DatabaseColumn>	indexedDatabaseColumns
protected Boolean	join
protected ItemList<DatabaseColumn>	joinedDatabaseColumns
protected String	longDescription
protected String	name
protected String	nativeId
protected Boolean	partition
protected String	shortDescription
protected String	type
protected Boolean	unique

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
DatabaseIndex()

Method Summary

Modifier and Type	Method and Description
List<String>	getExpression() Retrieve the expression property (displayed as 'Expression') of the object.
Boolean	getFunction() Retrieve the function property (displayed as 'Function') of the object.
ItemList<DatabaseColumn>	getIndexedDatabaseColumns() Retrieve the indexed_database_columns property (displayed as 'Database Columns') of the object.
Boolean	getJoin() Retrieve the join property (displayed as 'Join') of the object.
ItemList<DatabaseColumn>	getJoinedDatabaseColumns() Retrieve the joined_database_columns property (displayed as 'Joined Database Columns') of the object.
String	getLongDescription() Retrieve the long_description property (displayed as 'Long Description') of the object.
String	getNativeId() Retrieve the native_id property (displayed as 'Native ID') of the object.
Boolean	getPartition() Retrieve the partition property (displayed as 'Partition') of the object.
String	getShortDescription() Retrieve the short_description property (displayed as 'Short Description') of the object.
String	getTheName() Retrieve the name property (displayed as 'Name') of the object.
String	getTheType() Retrieve the type property (displayed as 'Type') of the object.
Boolean	getUnique() Retrieve the unique property (displayed as 'Unique Index') of the object.
void	setExpression(List<String> expression) Set the expression property (displayed as Expression) of the object.
void	setFunction(Boolean function) Set the function property (displayed as Function) of the object.
void	setIndexedDatabaseColumns(ItemList<DatabaseColumn> indexedDatabaseColumns) Set the indexed_database_columns property (displayed as Database Columns) of the object.
void	setJoin(Boolean join) Set the join property (displayed as Join) of the object.
void	setJoinedDatabaseColumns(ItemList<DatabaseColumn> joinedDatabaseColumns) Set the joined_database_columns property (displayed as Joined Database Columns) of the object.
void	setLongDescription(String longDescription) Set the long_description property (displayed as Long Description) of the object.
void	setNativeId(String nativeId) Set the native_id property (displayed as Native ID) of the object.
void	setPartition(Boolean partition) Set the partition property (displayed as Partition) of the object.
void	setShortDescription(String shortDescription) Set the short_description property (displayed as Short Description) of the object.
void	setTheName(String name) Set the name property (displayed as Name) of the object.
void	setTheType(String type) Set the type property (displayed as Type) of the object.
void	setUnique(Boolean unique) Set the unique property (displayed as Unique Index) 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

expression

protected List<String> expression

function

protected Boolean function

indexedDatabaseColumns

protected ItemList<DatabaseColumn> indexedDatabaseColumns

join

protected Boolean join

joinedDatabaseColumns

protected ItemList<DatabaseColumn> joinedDatabaseColumns

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

partition

protected Boolean partition

shortDescription

protected String shortDescription

type

protected String type

unique

protected Boolean unique

Constructor Detail

DatabaseIndex

public DatabaseIndex()

Method Detail

getExpression

public List<String> getExpression()

Retrieve the expression property (displayed as 'Expression') of the object.

Returns:

List<String>

setExpression

public void setExpression(List<String> expression)

Set the expression property (displayed as Expression) of the object.

Parameters:

expression - the value to set

getFunction

public Boolean getFunction()

Retrieve the function property (displayed as 'Function') of the object.

Returns:

Boolean

setFunction

public void setFunction(Boolean function)

Set the function property (displayed as Function) of the object.

Parameters:

function - the value to set

getIndexedDatabaseColumns

public ItemList<DatabaseColumn> getIndexedDatabaseColumns()

Retrieve the indexed_database_columns property (displayed as 'Database Columns') of the object.

Returns:

ItemList<DatabaseColumn>

setIndexedDatabaseColumns

public void setIndexedDatabaseColumns(ItemList<DatabaseColumn> indexedDatabaseColumns)

Set the indexed_database_columns property (displayed as Database Columns) of the object.

Parameters:

indexedDatabaseColumns - the value to set

getJoin

public Boolean getJoin()

Retrieve the join property (displayed as 'Join') of the object.

Returns:

Boolean

setJoin

public void setJoin(Boolean join)

Set the join property (displayed as Join) of the object.

Parameters:

join - the value to set

getJoinedDatabaseColumns

public ItemList<DatabaseColumn> getJoinedDatabaseColumns()

Retrieve the joined_database_columns property (displayed as 'Joined Database Columns') of the object.

Returns:

ItemList<DatabaseColumn>

setJoinedDatabaseColumns

public void setJoinedDatabaseColumns(ItemList<DatabaseColumn> joinedDatabaseColumns)

Set the joined_database_columns property (displayed as Joined Database Columns) of the object.

Parameters:

joinedDatabaseColumns - 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

getTheName

public String getTheName()

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

Returns:

String

setTheName

public void setTheName(String name)

Set the name property (displayed as Name) of the object.

Parameters:

name - 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

getPartition

public Boolean getPartition()

Retrieve the partition property (displayed as 'Partition') of the object.

Returns:

Boolean

setPartition

public void setPartition(Boolean partition)

Set the partition property (displayed as Partition) of the object.

Parameters:

partition - 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

getTheType

public String getTheType()

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

Returns:

String

setTheType

public void setTheType(String type)

Set the type property (displayed as Type) of the object.

Parameters:

type - the value to set

getUnique

public Boolean getUnique()

Retrieve the unique property (displayed as 'Unique Index') of the object.

Returns:

Boolean

setUnique

public void setUnique(Boolean unique)

Set the unique property (displayed as Unique Index) of the object.

Parameters:

unique - the value to set