Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkSchemaMapping

All Known Implementing Classes:
DKSchemaMappingFed

public interface dkSchemaMapping

This is the an interface to define an associative mapping between a mapped or federated entity and a map-to or native entity in back-end datastores.


Method Summary
 void clearCache()
          Clear schema mapping cache
 java.lang.String getAssocEntityName()
          Gets the name of the associated native entity.
 java.lang.String getAssocMappedEntityName()
          Gets the name of the associated mapped or federated entity.
 java.lang.String getAssocServerName()
          Gets the name of the associated server where native attributes are defined.
 dkAttrMapping getAttrMapping(java.lang.String attrMappingName)
          Gets an existing attribute mapping given its name.
 dkAttrMapping getAttrMappingByMappedName(java.lang.String mappedAttrName)
          Gets attribute mapping object by the given the mapped attribute name
 dkAttrMapping getAttrMappingByMapToName(java.lang.String mapToAttrName)
          Gets attribute mapping object by the given the map-to attribute name.
 java.lang.String getEntityName()
          Gets the name of the native entity.
 java.lang.String getMappedEntityName()
          Gets the name of the mapped or federated entity.
 short getMappedEntityType()
          Gets the name of the mapped or federated entity type.
 java.lang.String getName()
          Gets the name of this SchemaMapping object
 java.lang.String getServerName()
          Gets the name of the server where native attributes are defined.
 java.lang.String getServerType()
          Gets the type of the server where native attributes are defined.
 boolean isAssocEntityTextSearchable()
          Check to see if associated entity is text searchable
 java.lang.String[] listAttrMappingNames()
          Lists all existing attribute mapping names defined in this schema mapping.
 dkCollection listAttrMappings()
          Lists all existing attribute mapping defined in this schema mapping.
 void retrieve()
          Retrieve this mapping from federated database
 void setAssocEntityName(java.lang.String assocNativeEntityName)
          Sets the name of the associated native entity.
 void setAssocEntityTextSearchable(boolean isTextSearchable)
          Set associated entity is text searchable indicator
 void setAssocMappedEntityName(java.lang.String assocMappedEntityName)
          Sets the name of the associated mapped or federated entity.
 void setAssocServerName(java.lang.String assocServerName)
          Sets the name of the associated server where native attributes are defined.
 void setEntityName(java.lang.String nativeEntityName)
          Sets the name of the native entity.
 void setMappedEntityName(java.lang.String mappedEntityName)
          Sets the name of the mapped or federated entity.
 void setMappedEntityType(short mappedEntityType)
          Sets the name of the mapped or federated entity type.
 void setName(java.lang.String name)
          Sets the name of this SchemaMapping object
 void setServerName(java.lang.String serverName)
          Sets the name of the server where native attributes are defined.
 void setServerType(java.lang.String serverType)
          Sets the type of the server where native attributes are defined.
 

Method Detail

getName

public java.lang.String getName()
Gets the name of this SchemaMapping object
Returns:
name of this object

setName

public void setName(java.lang.String name)
Sets the name of this SchemaMapping object
Parameters:
extName - name of this SchemaMapping object

getServerName

public java.lang.String getServerName()
Gets the name of the server where native attributes are defined.
Returns:
server name

setServerName

public void setServerName(java.lang.String serverName)
Sets the name of the server where native attributes are defined.
Parameters:
serverName - back-end server name

getServerType

public java.lang.String getServerType()
Gets the type of the server where native attributes are defined. It could be one of DK_DL_DSTYPE, DK_OD_DSTYPE, etc
Returns:
server type

setServerType

public void setServerType(java.lang.String serverType)
Sets the type of the server where native attributes are defined.
Parameters:
serverType - server type

getEntityName

public java.lang.String getEntityName()
Gets the name of the native entity.
Returns:
native entity name, for example this could be the index class name if the server type is DL/VI, or it could be the application group name if the server type if OnDemand.

setEntityName

public void setEntityName(java.lang.String nativeEntityName)
Sets the name of the native entity.
Parameters:
nativeEntityName - name of the native entity (index class name for example)

getMappedEntityName

public java.lang.String getMappedEntityName()
Gets the name of the mapped or federated entity.
Returns:
federated entity name

setMappedEntityName

public void setMappedEntityName(java.lang.String mappedEntityName)
Sets the name of the mapped or federated entity.
Parameters:
mappedEntityName - federated entity name

getMappedEntityType

public short getMappedEntityType()
Gets the name of the mapped or federated entity type.
Returns:
federated entity type

setMappedEntityType

public void setMappedEntityType(short mappedEntityType)
Sets the name of the mapped or federated entity type.
Parameters:
mappedEntityName - federated entity type

getAssocMappedEntityName

public java.lang.String getAssocMappedEntityName()
Gets the name of the associated mapped or federated entity.
Returns:
associated federated entity name

setAssocMappedEntityName

public void setAssocMappedEntityName(java.lang.String assocMappedEntityName)
Sets the name of the associated mapped or federated entity.
Parameters:
mappedEntityName - associated federated entity name

getAssocEntityName

public java.lang.String getAssocEntityName()
Gets the name of the associated native entity.
Returns:
associated native entity name, for example this could be the index class name if the server type is DL/VI, or it could be the application group name if the server type if OnDemand.

setAssocEntityName

public void setAssocEntityName(java.lang.String assocNativeEntityName)
Sets the name of the associated native entity.
Parameters:
nativeEntityName - name of the associated native entity (index class name for example)

getAssocServerName

public java.lang.String getAssocServerName()
Gets the name of the associated server where native attributes are defined.
Returns:
associated server name

setAssocServerName

public void setAssocServerName(java.lang.String assocServerName)
Sets the name of the associated server where native attributes are defined.
Parameters:
serverName - back-end associated server name

getAttrMapping

public dkAttrMapping getAttrMapping(java.lang.String attrMappingName)
                             throws DKException
Gets an existing attribute mapping given its name.
Parameters:
attrMappingName - federated entity mapping name to be retrieved
Throws:
DKException - - an error occurs in the datastore

listAttrMappings

public dkCollection listAttrMappings()
                              throws DKException
Lists all existing attribute mapping defined in this schema mapping.
Returns:
a collection of dkAttrMapping objects defining the mapping.
Throws:
DKException - - an error occurs in the datastore

listAttrMappingNames

public java.lang.String[] listAttrMappingNames()
                                        throws DKException
Lists all existing attribute mapping names defined in this schema mapping.
Returns:
an array of attribute mampping names.
Throws:
DKException - - an error occurs in the datastore

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieve this mapping from federated database
Throws:
DKException - - an error occurs in the datastore

getAttrMappingByMappedName

public dkAttrMapping getAttrMappingByMappedName(java.lang.String mappedAttrName)
                                         throws DKException
Gets attribute mapping object by the given the mapped attribute name
Returns:
attribute mapping object

getAttrMappingByMapToName

public dkAttrMapping getAttrMappingByMapToName(java.lang.String mapToAttrName)
                                        throws DKException
Gets attribute mapping object by the given the map-to attribute name.
Returns:
attribute mapping object

isAssocEntityTextSearchable

public boolean isAssocEntityTextSearchable()
                                    throws DKException,
                                           java.lang.Exception
Check to see if associated entity is text searchable
Returns:
true if associate entity is text searchable

setAssocEntityTextSearchable

public void setAssocEntityTextSearchable(boolean isTextSearchable)
                                  throws DKException,
                                         java.lang.Exception
Set associated entity is text searchable indicator

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear schema mapping cache

Note:DKUsageError exception thrown if method is not implemented


EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.