wt.federation
Class DirectoryTranslationTable

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

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class DirectoryTranslationTable

extends Item

implements Externalizable

Use the newDirectoryTranslationTable static factory method(s), not the DirectoryTranslationTable 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

Field Summary

static String	CLASS_FILTER_TABLE Label for the attribute.
private Hashtable	classFilterTable
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TABLE_NAME Label for the attribute.
private static int	TABLE_NAME_UPPER_LIMIT
private String	tableName
static String	TEMPLATE_TABLE Label for the attribute.
private Hashtable	templateTable
static String	TRANSLATION_TABLE Label for the attribute.
private Hashtable	translationTable

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

DirectoryTranslationTable()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getAttributeForField(Class javaClass, String fieldName) Return the directory attribute name associated with a specified field name of a specified class.
String	getClassFilter(Class javaClass) Return the directory search filter that can be used to find all entries corresponding to the specified Java class.
Hashtable	getClassFilterTable() Gets the value of the attribute: CLASS_FILTER_TABLE.
Hashtable	getClassTable(Class javaClass) Return the Hashtable defining translations between the field names of a specified class and directory attribute names.
Hashtable	getClassTemplate(Class javaClass) Return the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.
String	getConceptualClassname() Deprecated.
Enumeration	getDefinedJavaClasses() Return the enumeration of Java class names for which there are translations to directory object classes.
Class	getJavaClass(String directoryClass) Get the Java class corresponding to a specified directory object class name.
String	getTableName() Gets the value of the attribute: TABLE_NAME.
Hashtable	getTemplateTable() Gets the value of the attribute: TEMPLATE_TABLE.
Hashtable	getTranslationTable() Gets the value of the attribute: TRANSLATION_TABLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(String name) Supports initialization, following construction of an instance.
static DirectoryTranslationTable	newDirectoryTranslationTable() Constructor returning an instance initialized with default property values.
static DirectoryTranslationTable	newDirectoryTranslationTable(String name) Constructor returning an instance initialized with a specified name and default property values.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(DirectoryTranslationTable thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributeForField(Class javaClass, String fieldName, String attributeName) Set the directory attribute name associated with a specified field name of a specified class.
void	setClassFilter(Class javaClass, String directoryFilter) Set the directory search filter that can be used to find all entries corresponding to the specified Java class.
void	setClassFilterTable(Hashtable a_ClassFilterTable) Sets the value of the attribute: CLASS_FILTER_TABLE.
void	setClassTable(Class javaClass, Hashtable translations) Set the Hashtable defining translations between the field names of a specified class and directory attribute names.
void	setClassTemplate(Class javaClass, Hashtable template) Set the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.
void	setJavaClass(String directoryClass, Class javaClass) Set the Java class associated with a specified directory object class name.
void	setTableName(String a_TableName) Sets the value of the attribute: TABLE_NAME.
void	setTemplateTable(Hashtable a_TemplateTable) Sets the value of the attribute: TEMPLATE_TABLE.
void	setTranslationTable(Hashtable a_TranslationTable) Sets the value of the attribute: TRANSLATION_TABLE.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.Item

getDomainRef, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TRANSLATION_TABLE

public static final String TRANSLATION_TABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

translationTable

private Hashtable translationTable

CLASS_FILTER_TABLE

public static final String CLASS_FILTER_TABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

classFilterTable

private Hashtable classFilterTable

TEMPLATE_TABLE

public static final String TEMPLATE_TABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

templateTable

private Hashtable templateTable

TABLE_NAME

public static final String TABLE_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TABLE_NAME_UPPER_LIMIT

private static int TABLE_NAME_UPPER_LIMIT

tableName

private String tableName

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

DirectoryTranslationTable

public DirectoryTranslationTable()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(DirectoryTranslationTable thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getTranslationTable

public Hashtable getTranslationTable()

Gets the value of the attribute: TRANSLATION_TABLE.

Supported API: false

Returns:

Hashtable

setTranslationTable

public void setTranslationTable(Hashtable a_TranslationTable)
                         throws WTPropertyVetoException

Sets the value of the attribute: TRANSLATION_TABLE.

Supported API: false

Parameters:

a_TranslationTable -

Throws:

WTPropertyVetoException

getClassFilterTable

public Hashtable getClassFilterTable()

Gets the value of the attribute: CLASS_FILTER_TABLE.

Supported API: false

Returns:

Hashtable

setClassFilterTable

public void setClassFilterTable(Hashtable a_ClassFilterTable)
                         throws WTPropertyVetoException

Sets the value of the attribute: CLASS_FILTER_TABLE.

Supported API: false

Parameters:

a_ClassFilterTable -

Throws:

WTPropertyVetoException

getTemplateTable

public Hashtable getTemplateTable()

Gets the value of the attribute: TEMPLATE_TABLE.

Supported API: false

Returns:

Hashtable

setTemplateTable

public void setTemplateTable(Hashtable a_TemplateTable)
                      throws WTPropertyVetoException

Sets the value of the attribute: TEMPLATE_TABLE.

Supported API: false

Parameters:

a_TemplateTable -

Throws:

WTPropertyVetoException

getTableName

public String getTableName()

Gets the value of the attribute: TABLE_NAME.

Supported API: false

Returns:

String

setTableName

public void setTableName(String a_TableName)

Sets the value of the attribute: TABLE_NAME.

Supported API: false

Parameters:

a_TableName -

newDirectoryTranslationTable

public static DirectoryTranslationTable newDirectoryTranslationTable()
                                                              throws FederationServicesException

Constructor returning an instance initialized with default property values.

Supported API: true

Returns:

DirectoryTranslationTable

Throws:

FederationServicesException

newDirectoryTranslationTable

public static DirectoryTranslationTable newDirectoryTranslationTable(String name)
                                                              throws FederationServicesException

Constructor returning an instance initialized with a specified name and default property values.

Supported API: true

Parameters:

name -

Returns:

DirectoryTranslationTable

Throws:

FederationServicesException

initialize

protected void initialize(String name)
                   throws FederationServicesException

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

Supported API: true

Parameters:

name -

Throws:

FederationServicesException

getClassFilter

public String getClassFilter(Class javaClass)

Return the directory search filter that can be used to find all entries corresponding to the specified Java class.

Supported API: true

Parameters:

javaClass -

Returns:

String

setClassFilter

public void setClassFilter(Class javaClass,
                           String directoryFilter)

Set the directory search filter that can be used to find all entries corresponding to the specified Java class.

Supported API: true

Parameters:

javaClass -

directoryFilter -

getDefinedJavaClasses

public Enumeration getDefinedJavaClasses()

Return the enumeration of Java class names for which there are translations to directory object classes.

Supported API: true

Returns:

Enumeration

getClassTable

public Hashtable getClassTable(Class javaClass)

Return the Hashtable defining translations between the field names of a specified class and directory attribute names.

Supported API: true

Parameters:

javaClass -

Returns:

Hashtable

setClassTable

public void setClassTable(Class javaClass,
                          Hashtable translations)

Set the Hashtable defining translations between the field names of a specified class and directory attribute names.

Supported API: true

Parameters:

javaClass -

translations -

getJavaClass

public Class getJavaClass(String directoryClass)

Get the Java class corresponding to a specified directory object class name.

Supported API: true

Parameters:

directoryClass -

Returns:

Class

setJavaClass

public void setJavaClass(String directoryClass,
                         Class javaClass)

Set the Java class associated with a specified directory object class name.

Supported API: true

Parameters:

directoryClass -

javaClass -

getAttributeForField

public String getAttributeForField(Class javaClass,
                                   String fieldName)

Return the directory attribute name associated with a specified field name of a specified class.

Supported API: true

Parameters:

javaClass -

fieldName -

Returns:

String

setAttributeForField

public void setAttributeForField(Class javaClass,
                                 String fieldName,
                                 String attributeName)

Set the directory attribute name associated with a specified field name of a specified class.

Supported API: true

Parameters:

javaClass -

fieldName -

attributeName -

getClassTemplate

public Hashtable getClassTemplate(Class javaClass)

Return the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.

Supported API: true

Parameters:

javaClass -

Returns:

Hashtable

setClassTemplate

public void setClassTemplate(Class javaClass,
                             Hashtable template)

Set the Hashtable defining a template that can be used to create a directory entry representing the specified Java class.

Supported API: true

Parameters:

javaClass -

template -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Item

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Item

Returns:

int

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