Package wt.federation

Class InfoEngineTranslationTable

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.federation._InfoEngineTranslationTable
wt.federation.InfoEngineTranslationTable
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification

Generate a unique identifier for a remote object given a key and a set of name/value substitutions.

Use the newInfoEngineTranslationTable static factory method(s), not the InfoEngineTranslationTable constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:
  • Field Summary

    Fields inherited from class wt.federation._InfoEngineTranslationTable

    CLASS_GROUP_TABLE, CLASS_TEMPLATE_TABLE, EXTERNALIZATION_VERSION_UID, ID_TEMPLATE_TABLE, TABLE_NAME, TABLE_TYPE, TRANSLATION_TABLE

    Fields inherited from class wt.fc.Item

    SIMPLE_X10_UID, VERSION_40_UID, VERSION_51_UID

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

    ADMINISTRATIVE_LOCK

    Fields inherited from interface wt.admin._DomainAdministered

    DOMAIN_REF, INHERITED_DOMAIN

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.access._SecurityLabeled

    SECURITY_LABELS

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

    Fields inherited from interface wt.access.SecurityLabeled

    SECURITY_LABELS_INTERNAL_VALUE
  • Method Summary

    Modifier and Type
    Method
    Description
    generateObjectId(Class linkClass, String role, Hashtable attributeTable, Hashtable arguments)
    Generate a unique identifier for a remote object given a link class that references it, the role that it plays in the association defined by the link class, and a set of name/value substitutions.
    generateObjectId(Class javaClass, Hashtable attributeTable, Hashtable arguments)
    Generate a unique identifier for a remote object given the Java class to which it is being mapped and a set of name/value substitutions.
    generateObjectId(String key, Hashtable attributeTable, Hashtable arguments)
    Generate a unique identifier for a remote object given a generic key and a set of name/value substitutions.
    generateSourceURL(Class javaClass, Hashtable attributeTable, Hashtable arguments)
    Generate a source URL for a remote object given the Java class to which it is mapped and a set of name/value substitutions.
    Return the template associated with the specified key.
    protected void
    Supports initialization, following construction of an instance.
    protected void
    initialize(String name, String type)
    Supports initialization, following construction of an instance.
    Constructor returning an instance initialized with default property values.
    Constructor returning an instance initialized with a specified name and type.
    void
    setClassAndGroup(Class javaClass, String groupName)
    Set the Java class associated with a specified Info*Engine group name, and vice versa.
    void
    setIdTemplate(Class javaClass, String template)
    Establish the template that will be used to generate unique identifiers for remote objects mapped to the specified Java class.
    void
    setIdTemplate(Class linkClass, String roleAName, String roleATemplate, String roleBName, String roleBTemplate)
    Establish the templates that will be used to generate unique identifiers for remote objects associated by a specified link class.
    void
    setIdTemplate(String key, String template)
    Establish the template that will be used to generate unique identifiers associated with the specified key.
    void
    setSourceURLTemplate(Class javaClass, String template)
    Establish the template that will be used to generate source URL's for remote objects mapped to the specified Java class.

    Methods inherited from class wt.federation._InfoEngineTranslationTable

    getClassGroupTable, getClassInfo, getClassTemplateTable, getConceptualClassname, getIdTemplateTable, getTableName, getTableType, getTranslationTable, getType, readExternal, readExternal, readVersion, setClassGroupTable, setClassTemplateTable, setIdTemplateTable, setTableName, setTableType, setTranslationTable, super_readExternal_InfoEngineTranslationTable, super_readVersion_InfoEngineTranslationTable, super_writeExternal_InfoEngineTranslationTable, writeExternal, writeExternal

    Methods inherited from class wt.fc._Item

    getAdministrativeLock, getDomainRef, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setInheritedDomain, setSecurityLabels, super_readExternal_Item, super_readVersion_Item, super_writeExternal_Item

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Method Details

    • newInfoEngineTranslationTable

      public static InfoEngineTranslationTable newInfoEngineTranslationTable() throws FederationServicesException, WTException
      Constructor returning an instance initialized with default property values.

      Supported API: true
      Returns:
      InfoEngineTranslationTable
      Throws:
      FederationServicesException
      WTException
    • newInfoEngineTranslationTable

      public static InfoEngineTranslationTable newInfoEngineTranslationTable(String name, String type) throws FederationServicesException
      Constructor returning an instance initialized with a specified name and type.

      Supported API: true
      Parameters:
      name -
      type -
      Returns:
      InfoEngineTranslationTable
      Throws:
      FederationServicesException
    • initialize

      protected void initialize(String name, String type) throws FederationServicesException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      name -
      type -
      Throws:
      FederationServicesException
    • setClassAndGroup

      public void setClassAndGroup(Class javaClass, String groupName)
      Set the Java class associated with a specified Info*Engine group name, and vice versa.

      Supported API: true
      Parameters:
      javaClass -
      groupName -
    • getIdTemplate

      public String getIdTemplate(String key)
      Return the template associated with the specified key.

      Supported API: true
      Parameters:
      key -
      Returns:
      String
    • setIdTemplate

      public void setIdTemplate(String key, String template)
      Establish the template that will be used to generate unique identifiers associated with the specified key.

      Supported API: true
      Parameters:
      key -
      template -
    • setIdTemplate

      public void setIdTemplate(Class javaClass, String template)
      Establish the template that will be used to generate unique identifiers for remote objects mapped to the specified Java class.

      Supported API: true
      Parameters:
      javaClass -
      template -
    • setIdTemplate

      public void setIdTemplate(Class linkClass, String roleAName, String roleATemplate, String roleBName, String roleBTemplate)
      Establish the templates that will be used to generate unique identifiers for remote objects associated by a specified link class.

      Supported API: true
      Parameters:
      linkClass -
      roleAName -
      roleATemplate -
      roleBName -
      roleBTemplate -
    • setSourceURLTemplate

      public void setSourceURLTemplate(Class javaClass, String template)
      Establish the template that will be used to generate source URL's for remote objects mapped to the specified Java class.

      Supported API: true
      Parameters:
      javaClass -
      template -
    • generateObjectId

      public String generateObjectId(Class javaClass, Hashtable attributeTable, Hashtable arguments)
      Generate a unique identifier for a remote object given the Java class to which it is being mapped and a set of name/value substitutions.

      Supported API: true
      Parameters:
      javaClass -
      attributeTable -
      arguments -
      Returns:
      String
    • generateObjectId

      public String generateObjectId(Class linkClass, String role, Hashtable attributeTable, Hashtable arguments)
      Generate a unique identifier for a remote object given a link class that references it, the role that it plays in the association defined by the link class, and a set of name/value substitutions.

      Supported API: true
      Parameters:
      linkClass -
      role -
      attributeTable -
      arguments -
      Returns:
      String
    • generateObjectId

      public String generateObjectId(String key, Hashtable attributeTable, Hashtable arguments)
      Generate a unique identifier for a remote object given a generic key and a set of name/value substitutions.

      Supported API: true
      Parameters:
      key -
      attributeTable -
      arguments -
      Returns:
      String
    • generateSourceURL

      public String generateSourceURL(Class javaClass, Hashtable attributeTable, Hashtable arguments)
      Generate a source URL for a remote object given the Java class to which it is mapped and a set of name/value substitutions.

      Supported API: true
      Parameters:
      javaClass -
      attributeTable -
      arguments -
      Returns:
      String
    • initialize

      protected void initialize() throws FederationServicesException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Overrides:
      initialize in class Item
      Throws:
      FederationServicesException