wt.federation
Class InfoEngineTranslationTable

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.federation.InfoEngineTranslationTable

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification

public class InfoEngineTranslationTable
extends Item
implements Externalizable

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:

Serialized Form

Method Summary

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.
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.
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.
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.
String	getIdTemplate(String key) Return the template associated with the specified key.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(String name, String type) Supports initialization, following construction of an instance.
static InfoEngineTranslationTable	newInfoEngineTranslationTable() Constructor returning an instance initialized with default property values.
static InfoEngineTranslationTable	newInfoEngineTranslationTable(String name, String type) 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.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newInfoEngineTranslationTable

public static InfoEngineTranslationTable newInfoEngineTranslationTable()
                                                                throws wt.federation.FederationServicesException

Constructor returning an instance initialized with default property values.

Supported API: true

Returns:

InfoEngineTranslationTable

Throws:

wt.federation.FederationServicesException

newInfoEngineTranslationTable

public static InfoEngineTranslationTable newInfoEngineTranslationTable(String name,
                                                                       String type)
                                                                throws wt.federation.FederationServicesException

Constructor returning an instance initialized with a specified name and type.

Supported API: true

Parameters:

name -

type -

Returns:

InfoEngineTranslationTable

Throws:

wt.federation.FederationServicesException

initialize

protected void initialize(String name,
                          String type)
                   throws wt.federation.FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

name -

type -

Throws:

wt.federation.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 wt.federation.FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Throws:

wt.federation.FederationServicesException