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

Class Reference

java.lang.Object

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

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

Direct Known Subclasses:

Acl, Aclentry, Actiondescriptor, AnalysisProject, AnalyticsObject, Applicationfunction, Applicationsetting, Archivedtask, AsclSteward, Associativeobject, BiFilter, BiFolder, BiHierarchyMember, BinaryInfosetOperation, BiOlapLevelElement, BiReportDataItemSource, BiReportSection, BiRootFolder, BlueprintElementLink, CandidateKey, CdcMapping, ChangedProperties, Classdescriptor, Classification, ClassificationContribution, Classificationtask, Collection, ColumnAnalysis, ColumnAnalysisSummary, Connector, Credential, Credentials, CustomAttribute, Customattributeval, DatabaseDomain, DatabaseIndex, DataConnection, DataConnectionMapping, DataItemProperties, DataItemValue, DataMapFilterOperation, DataRuleResults, Datasourcealiasgroup, DatastageItem, Derivation, DesignForeignKey, DesignKey, DevelopmentLog, Directoryproviderconfiguration, Directoryproviderproperty, Dsargumentmap, DsdataConnection, Dsexternaldependency, Dsfolder, Dsmetabag, Dsmfcolumninfo, Dsparameter, DsparameterJob, DsparameterSet, DuplicatesOperation, ExceptionFilterOperation, ExtensionMapping, FieldAnalysis, FileRecordAnalysis, FilterOperation, Folder, ForeignKey, ForeignKeyDefinition, FunctionCall, FunctionCall2, Group, IndexMember, InferredForeignKey, InferredKey, InformationServerReport, InformationServerReportAnalysisProject, InformationServerReportDatabase, InformationServerReportJob, InformationServerReportMappingProject, InformationServerReportMappingSpecification, InformationServerReportParameters, InformationServerReportParamJob, InformationServerReportSteward, InformationServicesArgument, InfosetOperation, Inputpin, InvDataRule, InvDataRuleDefinition, InvDataRuleSet, InvDataRuleSetDefinition, JobConstraint, JobFailEvent, JobInputPin, JobOutputPin, JobParameter, JobReadEvent, JobRun, JobRunActivity, JobStageParameters, JobWriteEvent, Keycomponent, Label, Lineagefilter, LineageReportTemplate, Link, Linktype, LogicalDomain, LogicalForeignKey, LogicalInversionKey, LogicalKey, LogicalValidationList, LogicalValidationRange, LogicalValidationRule, LogicalVariable, MainObject, Mapping, MappingComponent, MappingFilter, MappingJoin, ModelEvalMetric, ModelInput, ModelLabel, MwbDatabaseAlias, Navigationdescriptor, NodeOperation, Note, OlapJoin, Olapjoinref, OlapMemberSource, OslcLink, Outputpin, ParameterSetDefinition, Parameterval, PhysicalDomain, Primarycategory, Propdescriptor, Providerpropertyinfo, Providerpropertyinfoextended, Providerpropertytype, QualityProblem, QualityProblemType, QualityProblemTypeDqr, ReferenceKey, RoleAssignment, RoleContext, RootTuple, SapConnection, SessionConfiguration, SetOperation, StageDataRuleDefinition, StandardizationObject, StandardizationRule, Steward, TableAnalysis, TableAnalysisSummary, TableDefinitionProperties, TermAssignment, TermHistory, TransformsFunction, Tuple, User, UserRole, ValidityTable, ValidValue, ValidValueList, ValidValueList2, ValidValueRange, ValidValueRange2, Validvaluerule, Validvalues, VolumeContribution, WarehouseMapping, XsdAttributeReference, XsdElementGroupReference, XsdElementReference, XsdForeignKey, XsdUniqueKey

public class Reference
extends ObjectPrinter

The ultimate parent object for all IGC assets, it contains only the most basic information common to every single asset in IGC, and present in every single reference to an IGC asset (whether via relationship, search result, etc):

• _name
• _type
• _id
• _url
• _context -- present for almost all assets

POJOs to represent user-defined objects (OpenIGC) should not extend this class directly, but the MainObject class.

Note that the default implementation has now changed to the Note class, as this is the ONLY type in IGC that does not contain a '_type' property. This means that any OpenIGC assets that have NOT been registered into the type system will default to a Note instance as well.

See Also:

IGCRestClient.registerPOJO(Class)

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Reference>	_context Provides the context to the unique identity of this asset.
protected String	_id The '_id' property defines the unique Repository ID (RID) of the asset.
protected String	_name The '_name' property of a Reference is equivalent to its 'name' property, but will always be populated on a reference ('name' may not yet be populated, depending on whether you have only a reference to the asset, or the full asset itself).
protected String	_type The '_type' property defines the type of asset this Reference represents.
protected String	_url The '_url' property provides a navigable link directly to the full details of asset this Reference represents, within a given IGC environment.
protected String	createdBy
protected Date	createdOn
protected String	modifiedBy
protected Date	modifiedOn
protected ItemList<Note>	notes

Constructor Summary

Constructors

Constructor and Description
Reference() Default constructor
Reference(String name, String type) Construct a simple stub representing an object instance in IGC.
Reference(String name, String type, String id) Construct a simple stub representing an object instance in IGC.

Method Summary

Modifier and Type	Method and Description
boolean	areModificationDetailsPopulated() Indicates whether the item's modification details (if any) have already been populated (true) or not (false).
List<Reference>	getContext() Retrieve the context of the IGC object instance.
String	getCreatedBy() Retrieve the created_by property (displayed as 'Created By') of the object.
Date	getCreatedOn() Retrieve the created_on property (displayed as 'Created On') of the object.
String	getId() Retrieve the Repository ID (RID) of the object instance.
Identity	getIdentity(IGCRestClient igcrest, ObjectCache cache) Retrieves the semantic identity of the asset.
String	getModifiedBy() Retrieve the modified_by property (displayed as 'Modified By') of the object.
Date	getModifiedOn() Retrieve the modified_on property (displayed as 'Modified On') of the object.
String	getName() Retrieve the name of the IGC object instance.
ItemList<Note>	getNotes() Retrieve the notes property (displayed as 'Notes') of the object.
String	getType() Retrieve the type of the IGC object instance.
String	getUrl() Retrieve the IGC REST API URL to the object instance's details.
boolean	isEmbeddedAsset() Indicates whether this item is an embedded asset (true) or not (false).
boolean	isFullyRetrieved() Determine whether this object instance is fully retrieved (true) or only partially (false).
boolean	isIdentityPopulated() Indicates whether this item's identity has already been populated (true) or not (false).
static boolean	isSimpleType(Object obj) Returns true iff the provided object is a simple type (String, Number, Boolean, Date, etc).
boolean	isVirtualAsset() Indicates whether this item is a virtual asset (true) or not (false).
void	setContext(List<Reference> _context) Set the context of the IGC object instance.
void	setCreatedBy(String createdBy) Set the created_by property (displayed as Created By) of the object.
void	setCreatedOn(Date createdOn) Set the created_on property (displayed as Created On) of the object.
void	setFullyRetrieved() Mark this object instance as fully-retrieved from IGC.
void	setId(String _id) Set the Repository ID (RID) of the object instance.
void	setModifiedBy(String modifiedBy) Set the modified_by property (displayed as Modified By) of the object.
void	setModifiedOn(Date modifiedOn) Set the modified_on property (displayed as Modified On) of the object.
void	setName(String _name) Set the name of the IGC object instance.
void	setNotes(ItemList<Note> notes) Set the notes property (displayed as Notes) of the object.
void	setType(String _type) Set the type of the IGC object instance.
void	setUrl(String _url) Set the IGC REST API URL of the object instance's details.

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

_context

protected List<Reference> _context

Provides the context to the unique identity of this asset. Note that while this will exist on almost all IGC assets, it is not present on absolutely all of them -- also be aware that without v11.7.0.2+ and an optional parameter it uses, this will always be 'null' in a ReferenceList

_name

protected String _name

The '_name' property of a Reference is equivalent to its 'name' property, but will always be populated on a reference ('name' may not yet be populated, depending on whether you have only a reference to the asset, or the full asset itself).

_type

protected String _type

The '_type' property defines the type of asset this Reference represents. To allow a Reference to be automatically translated into a Java object, you must first register the Java class that should interpret this data type using IGCRestClient.registerPOJO(Class).

_id

protected String _id

The '_id' property defines the unique Repository ID (RID) of the asset. This ID should be unique within an instance (environment) of IGC.

_url

protected String _url

The '_url' property provides a navigable link directly to the full details of asset this Reference represents, within a given IGC environment.

createdBy

protected String createdBy

createdOn

protected Date createdOn

modifiedBy

protected String modifiedBy

modifiedOn

protected Date modifiedOn

notes

protected ItemList<Note> notes

Constructor Detail

Reference

public Reference()

Default constructor

Reference

public Reference(String name,
                 String type)

Construct a simple stub representing an object instance in IGC.

Parameters:

name - name of the object instance

type - type of the object instance

Reference

public Reference(String name,
                 String type,
                 String id)

Construct a simple stub representing an object instance in IGC.

Parameters:

name - name of the object instance

type - type of the object instance

id - repository ID (RID) of the object instance

Method Detail

getContext

public List<Reference> getContext()

Retrieve the context of the IGC object instance.

Returns:

List<Reference>

See Also:

_context

setContext

public void setContext(List<Reference> _context)

Set the context of the IGC object instance.

Parameters:

_context - of the IGC object instance

See Also:

_context

getName

public String getName()

Retrieve the name of the IGC object instance.

Returns:

String

See Also:

_name

setName

public void setName(String _name)

Set the name of the IGC object instance.

Parameters:

_name - of the IGC object instance

See Also:

_name

getType

public String getType()

Retrieve the type of the IGC object instance.

Returns:

String

See Also:

_type

setType

public void setType(String _type)

Set the type of the IGC object instance.

Parameters:

_type - of the IGC object instance

See Also:

_type

getId

public String getId()

Retrieve the Repository ID (RID) of the object instance.

Returns:

String

See Also:

_id

setId

public void setId(String _id)

Set the Repository ID (RID) of the object instance.

Parameters:

_id - of the IGC object instance

See Also:

_id

getUrl

public String getUrl()

Retrieve the IGC REST API URL to the object instance's details.

Returns:

String

See Also:

_url

setUrl

public void setUrl(String _url)

Set the IGC REST API URL of the object instance's details.

Parameters:

_url - of the IGC object instance

See Also:

_url

getCreatedBy

public String getCreatedBy()

Retrieve the created_by property (displayed as 'Created By') of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Returns:

String

setCreatedBy

public void setCreatedBy(String createdBy)

Set the created_by property (displayed as Created By) of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Parameters:

createdBy - the value to set

getCreatedOn

public Date getCreatedOn()

Retrieve the created_on property (displayed as 'Created On') of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Returns:

Date

setCreatedOn

public void setCreatedOn(Date createdOn)

Set the created_on property (displayed as Created On) of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Parameters:

createdOn - the value to set

getModifiedBy

public String getModifiedBy()

Retrieve the modified_by property (displayed as 'Modified By') of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Returns:

String

setModifiedBy

public void setModifiedBy(String modifiedBy)

Set the modified_by property (displayed as Modified By) of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Parameters:

modifiedBy - the value to set

getModifiedOn

public Date getModifiedOn()

Retrieve the modified_on property (displayed as 'Modified On') of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Returns:

Date

setModifiedOn

public void setModifiedOn(Date modifiedOn)

Set the modified_on property (displayed as Modified On) of the object. Note: not all objects in IGC have this information, but for re-usability purposes these are held at top-level.

Parameters:

modifiedOn - the value to set

getNotes

public ItemList<Note> getNotes()

Retrieve the notes property (displayed as 'Notes') of the object.

Returns:

ItemList<Note>

setNotes

public void setNotes(ItemList<Note> notes)

Set the notes property (displayed as Notes) of the object.

Parameters:

notes - the value to set

isFullyRetrieved

public boolean isFullyRetrieved()

Determine whether this object instance is fully retrieved (true) or only partially (false).

Returns:

boolean

setFullyRetrieved

public void setFullyRetrieved()

Mark this object instance as fully-retrieved from IGC.

isSimpleType

public static boolean isSimpleType(Object obj)

Returns true iff the provided object is a simple type (String, Number, Boolean, Date, etc).

Parameters:

obj - the object to check

Returns:

Boolean

areModificationDetailsPopulated

public boolean areModificationDetailsPopulated()

Indicates whether the item's modification details (if any) have already been populated (true) or not (false).

Returns:

boolean

isIdentityPopulated

public boolean isIdentityPopulated()

Indicates whether this item's identity has already been populated (true) or not (false).

Returns:

boolean

isVirtualAsset

public boolean isVirtualAsset()

Indicates whether this item is a virtual asset (true) or not (false).

Returns:

boolean

isEmbeddedAsset

public boolean isEmbeddedAsset()

Indicates whether this item is an embedded asset (true) or not (false).

Returns:

boolean

getIdentity

public Identity getIdentity(IGCRestClient igcrest,
                            ObjectCache cache)
                     throws IGCConnectivityException,
                            IGCParsingException,
                            IGCIOException

Retrieves the semantic identity of the asset.

Parameters:

igcrest - a REST API connection to use in confirming the identity of the asset

cache - a cache of information that may already have been retrieved about the provided object

Returns:

Identity

Throws:

IGCConnectivityException - if there is any connectivity issue during the request

IGCParsingException - if there is any issue parsing the response from IGC

IGCIOException - if there is any issue accessing the POJO defining the type and its properties