Package com.atlan.model.assets

Class BIProcess

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.BIProcess
All Implemented Interfaces:
IAsset, IBIProcess, ILineageProcess, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class BIProcess extends Asset implements IBIProcess, ILineageProcess, IAsset, IReferenceable
Instance of business intelligence lineage in Atlan. These are used to short-circuit lineage from table-like assets directly to dashboard-like assets.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public BIProcess trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a BIProcess, from a potentially more-complete BIProcess object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the BIProcess
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a BIProcess relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all BIProcess assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) BIProcess assets will be included.
      Returns:
      a fluent search that includes all BIProcess assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all BIProcess assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) BIProcess assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all BIProcess assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all BIProcess assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) BIProcesss will be included
      Returns:
      a fluent search that includes all BIProcess assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all BIProcess assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) BIProcesss will be included
      Returns:
      a fluent search that includes all BIProcess assets

    • refByGuid

      public static BIProcess refByGuid(String guid)
      Reference to a BIProcess by GUID. Use this to create a relationship to this BIProcess, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the BIProcess to reference
      Returns:
      reference to a BIProcess that can be used for defining a relationship to a BIProcess

    • refByGuid

      public static BIProcess refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a BIProcess by GUID. Use this to create a relationship to this BIProcess, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the BIProcess to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a BIProcess that can be used for defining a relationship to a BIProcess

    • refByQualifiedName

      public static BIProcess refByQualifiedName(String qualifiedName)
      Reference to a BIProcess by qualifiedName. Use this to create a relationship to this BIProcess, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the BIProcess to reference
      Returns:
      reference to a BIProcess that can be used for defining a relationship to a BIProcess

    • refByQualifiedName

      public static BIProcess refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a BIProcess by qualifiedName. Use this to create a relationship to this BIProcess, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the BIProcess to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a BIProcess that can be used for defining a relationship to a BIProcess

    • get

      public static BIProcess get(String id) throws AtlanException
      Retrieves a BIProcess by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the BIProcess to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full BIProcess, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the BIProcess does not exist or the provided GUID is not a BIProcess

    • get

      public static BIProcess get(AtlanClient client, String id) throws AtlanException
      Retrieves a BIProcess by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the BIProcess to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full BIProcess, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the BIProcess does not exist or the provided GUID is not a BIProcess

    • get

      public static BIProcess get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a BIProcess by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the BIProcess to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full BIProcess, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the BIProcess does not exist or the provided GUID is not a BIProcess

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) BIProcess to active.
      Parameters:
      qualifiedName - for the BIProcess
      Returns:
      true if the BIProcess is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) BIProcess to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the BIProcess
      Returns:
      true if the BIProcess is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • updater

      public static BIProcess.BIProcessBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the minimal request necessary to update the BIProcess, as a builder

    • trimToRequired

      public BIProcess.BIProcessBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a BIProcess, from a potentially more-complete BIProcess object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the BIProcess, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for BIProcess are not found in the initial object

    • removeDescription

      public static BIProcess removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static BIProcess removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static BIProcess removeUserDescription(String qualifiedName, String name) throws AtlanException
      Remove the user's description from a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static BIProcess removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static BIProcess removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static BIProcess removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the BIProcess's owners
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static BIProcess updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated BIProcess, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static BIProcess updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the BIProcess's certificate
      qualifiedName - of the BIProcess
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated BIProcess, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static BIProcess removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static BIProcess removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the BIProcess's certificate
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static BIProcess updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static BIProcess updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the BIProcess's announcement
      qualifiedName - of the BIProcess
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static BIProcess removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static BIProcess removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a BIProcess.
      Parameters:
      client - connectivity to the Atlan client from which to remove the BIProcess's announcement
      qualifiedName - of the BIProcess
      name - of the BIProcess
      Returns:
      the updated BIProcess, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static BIProcess replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the BIProcess.
      Parameters:
      qualifiedName - for the BIProcess
      name - human-readable name of the BIProcess
      terms - the list of terms to replace on the BIProcess, or null to remove all terms from the BIProcess
      Returns:
      the BIProcess that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static BIProcess replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the BIProcess's assigned terms
      qualifiedName - for the BIProcess
      name - human-readable name of the BIProcess
      terms - the list of terms to replace on the BIProcess, or null to remove all terms from the BIProcess
      Returns:
      the BIProcess that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static BIProcess appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the BIProcess, without replacing existing terms linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the BIProcess
      terms - the list of terms to append to the BIProcess
      Returns:
      the BIProcess that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static BIProcess appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the BIProcess, without replacing existing terms linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the BIProcess
      qualifiedName - for the BIProcess
      terms - the list of terms to append to the BIProcess
      Returns:
      the BIProcess that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static BIProcess removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a BIProcess, without replacing all existing terms linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the BIProcess
      terms - the list of terms to remove from the BIProcess, which must be referenced by GUID
      Returns:
      the BIProcess that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static BIProcess removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a BIProcess, without replacing all existing terms linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the BIProcess
      qualifiedName - for the BIProcess
      terms - the list of terms to remove from the BIProcess, which must be referenced by GUID
      Returns:
      the BIProcess that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static BIProcess appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a BIProcess, without replacing existing Atlan tags linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the BIProcess
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated BIProcess
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static BIProcess appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a BIProcess, without replacing existing Atlan tags linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the BIProcess
      qualifiedName - of the BIProcess
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated BIProcess
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static BIProcess appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a BIProcess, without replacing existing Atlan tags linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the BIProcess
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated BIProcess
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static BIProcess appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a BIProcess, without replacing existing Atlan tags linked to the BIProcess. Note: this operation must make two API calls — one to retrieve the BIProcess's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the BIProcess
      qualifiedName - of the BIProcess
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated BIProcess
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a BIProcess.
      Parameters:
      qualifiedName - of the BIProcess
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the BIProcess

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a BIProcess.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a BIProcess
      qualifiedName - of the BIProcess
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the BIProcess

    • _internal

      public static BIProcess.BIProcessBuilder<?,?> _internal()

    • toBuilder

      public BIProcess.BIProcessBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAdditionalEtlContext

      public String getAdditionalEtlContext()
      Additional Context of the ETL pipeline/notebook which creates the process.
      Specified by:
      getAdditionalEtlContext in interface IBIProcess
      Specified by:
      getAdditionalEtlContext in interface ILineageProcess

    • getAdfActivity

      public IAdfActivity getAdfActivity()
      ADF Activity that is associated with this lineage process.
      Specified by:
      getAdfActivity in interface IBIProcess
      Specified by:
      getAdfActivity in interface ILineageProcess

    • getAirflowTasks

      public SortedSet<IAirflowTask> getAirflowTasks()
      Tasks that exist within this process.
      Specified by:
      getAirflowTasks in interface IBIProcess
      Specified by:
      getAirflowTasks in interface ILineageProcess

    • getAst

      public String getAst()
      Parsed AST of the code or SQL statements that describe the logic of this process.
      Specified by:
      getAst in interface IBIProcess
      Specified by:
      getAst in interface ILineageProcess

    • getCode

      public String getCode()
      Code that ran within the process.
      Specified by:
      getCode in interface IBIProcess
      Specified by:
      getCode in interface ILineageProcess

    • getColumnProcesses

      public SortedSet<IColumnProcess> getColumnProcesses()
      Processes that detail column-level lineage for this process.
      Specified by:
      getColumnProcesses in interface IBIProcess
      Specified by:
      getColumnProcesses in interface ILineageProcess

    • getFivetranConnector

      public IFivetranConnector getFivetranConnector()
      fivetranConnector in which this process exists.
      Specified by:
      getFivetranConnector in interface IBIProcess
      Specified by:
      getFivetranConnector in interface ILineageProcess

    • getInputs

      public SortedSet<ICatalog> getInputs()
      Assets that are inputs to this process.
      Specified by:
      getInputs in interface IBIProcess
      Specified by:
      getInputs in interface ILineageProcess

    • getMatillionComponent

      public IMatillionComponent getMatillionComponent()
      Matillion component that contains the logic for this lineage process.
      Specified by:
      getMatillionComponent in interface IBIProcess
      Specified by:
      getMatillionComponent in interface ILineageProcess

    • getOutputs

      public SortedSet<ICatalog> getOutputs()
      Assets that are outputs from this process.
      Specified by:
      getOutputs in interface IBIProcess
      Specified by:
      getOutputs in interface ILineageProcess

    • getPowerBIDataflow

      public IPowerBIDataflow getPowerBIDataflow()
      PowerBI Dataflow that is associated with this lineage process.
      Specified by:
      getPowerBIDataflow in interface IBIProcess
      Specified by:
      getPowerBIDataflow in interface ILineageProcess

    • getSparkJobs

      public SortedSet<ISparkJob> getSparkJobs()
      TBC
      Specified by:
      getSparkJobs in interface IBIProcess
      Specified by:
      getSparkJobs in interface ILineageProcess

    • getSql

      public String getSql()
      SQL query that ran to produce the outputs.
      Specified by:
      getSql in interface IBIProcess
      Specified by:
      getSql in interface ILineageProcess

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset

    • getTypeName

      public String getTypeName()
      Fixed typeName for BIProcesss.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IBIProcess
      Specified by:
      getTypeName in interface ILineageProcess
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference