Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSchemaMappingFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSchemaMappingFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, dkSchemaMapping, java.io.Serializable

public class DKSchemaMappingFed
extends java.lang.Object
implements dkSchemaMapping, DKConstantFed, DKMessageIdFed, java.io.Serializable

See Also:
Serialized Form

Field Summary
 java.lang.String _assocEntityName
           
 java.lang.String _assocMappedEntityName
           
 java.lang.String _assocServerName
           
 java.lang.String _entityName
           
 java.lang.String _mappedEntityDesc
           
 java.lang.String _mappedEntityName
           
 short _mappedEntityType
           
 java.util.Vector _mapping
           
 java.lang.String _name
           
 java.lang.String _serverName
           
 java.lang.String _serverType
           
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKSchemaMappingFed()
           
DKSchemaMappingFed(dkDatastore ds)
           
DKSchemaMappingFed(java.lang.String name)
           
 
Method Summary
 void add()
           
 void addAttrMapping(dkAttrMapping attrMapping)
           
 void clearCache()
          Clears all current cache data
 void del()
           
 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.
 com.ibm.mm.sdk.internal.PSchemaMappingExtFed getExtension()
           
 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 removeAttrMapping(java.lang.String attrMappingName)
           
 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 setDatastore(dkDatastore ds)
           
 void setEntityName(java.lang.String nativeEntityName)
          Sets the name of the native entity.
 void setExtension(com.ibm.mm.sdk.internal.PSchemaMappingExtFed smext)
           
 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.
 void update()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_name

public java.lang.String _name

_serverName

public java.lang.String _serverName

_serverType

public java.lang.String _serverType

_entityName

public java.lang.String _entityName

_mappedEntityName

public java.lang.String _mappedEntityName

_mappedEntityDesc

public java.lang.String _mappedEntityDesc

_mappedEntityType

public short _mappedEntityType

_assocMappedEntityName

public java.lang.String _assocMappedEntityName

_assocEntityName

public java.lang.String _assocEntityName

_assocServerName

public java.lang.String _assocServerName

_mapping

public java.util.Vector _mapping
Constructor Detail

DKSchemaMappingFed

public DKSchemaMappingFed()

DKSchemaMappingFed

public DKSchemaMappingFed(java.lang.String name)

DKSchemaMappingFed

public DKSchemaMappingFed(dkDatastore ds)
Method Detail

getName

public java.lang.String getName()
Description copied from interface: dkSchemaMapping
Gets the name of this SchemaMapping object
Specified by:
getName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Returns:
name of this object

setName

public void setName(java.lang.String name)
Description copied from interface: dkSchemaMapping
Sets the name of this SchemaMapping object
Specified by:
setName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Parameters:
extName - name of this SchemaMapping object

getServerName

public java.lang.String getServerName()
Description copied from interface: dkSchemaMapping
Gets the name of the server where native attributes are defined.
Specified by:
getServerName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Returns:
server name

setServerName

public void setServerName(java.lang.String serverName)
Description copied from interface: dkSchemaMapping
Sets the name of the server where native attributes are defined.
Specified by:
setServerName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Parameters:
serverName - back-end server name

getServerType

public java.lang.String getServerType()
Description copied from interface: dkSchemaMapping
Gets the type of the server where native attributes are defined. It could be one of DK_DL_DSTYPE, DK_OD_DSTYPE, etc
Specified by:
getServerType in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Returns:
server type

setServerType

public void setServerType(java.lang.String serverType)
Description copied from interface: dkSchemaMapping
Sets the type of the server where native attributes are defined.
Specified by:
setServerType in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Parameters:
serverType - server type

getEntityName

public java.lang.String getEntityName()
Description copied from interface: dkSchemaMapping
Gets the name of the native entity.
Specified by:
getEntityName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
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)
Description copied from interface: dkSchemaMapping
Sets the name of the native entity.
Specified by:
setEntityName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Parameters:
nativeEntityName - name of the native entity (index class name for example)

getMappedEntityName

public java.lang.String getMappedEntityName()
Description copied from interface: dkSchemaMapping
Gets the name of the mapped or federated entity.
Specified by:
getMappedEntityName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Returns:
federated entity name

setMappedEntityName

public void setMappedEntityName(java.lang.String mappedEntityName)
Description copied from interface: dkSchemaMapping
Sets the name of the mapped or federated entity.
Specified by:
setMappedEntityName in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Parameters:
mappedEntityName - federated entity name

getMappedEntityType

public short getMappedEntityType()
Gets the name of the mapped or federated entity type.
Specified by:
getMappedEntityType in interface dkSchemaMapping
Returns:
federated entity type

setMappedEntityType

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

getAssocMappedEntityName

public java.lang.String getAssocMappedEntityName()
Gets the name of the associated mapped or federated entity.
Specified by:
getAssocMappedEntityName in interface dkSchemaMapping
Returns:
associated federated entity name

setAssocMappedEntityName

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

getAssocEntityName

public java.lang.String getAssocEntityName()
Gets the name of the associated native entity.
Specified by:
getAssocEntityName in interface dkSchemaMapping
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.
Specified by:
setAssocEntityName in interface dkSchemaMapping
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.
Specified by:
getAssocServerName in interface dkSchemaMapping
Returns:
associated server name

setAssocServerName

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

addAttrMapping

public void addAttrMapping(dkAttrMapping attrMapping)
                    throws DKException

removeAttrMapping

public void removeAttrMapping(java.lang.String attrMappingName)
                       throws DKException

getAttrMapping

public dkAttrMapping getAttrMapping(java.lang.String attrMappingName)
                             throws DKException
Description copied from interface: dkSchemaMapping
Gets an existing attribute mapping given its name.
Specified by:
getAttrMapping in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Parameters:
attrMappingName - federated entity mapping name to be retrieved
Throws:
DKException - - an error occurs in the datastore

listAttrMappings

public dkCollection listAttrMappings()
                              throws DKException
Description copied from interface: dkSchemaMapping
Lists all existing attribute mapping defined in this schema mapping.
Specified by:
listAttrMappings in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
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
Description copied from interface: dkSchemaMapping
Lists all existing attribute mapping names defined in this schema mapping.
Specified by:
listAttrMappingNames in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Returns:
an array of attribute mampping names.
Throws:
DKException - - an error occurs in the datastore

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Description copied from interface: dkSchemaMapping
Retrieve this mapping from federated database
Specified by:
retrieve in interface dkSchemaMapping
Following copied from interface: com.ibm.mm.sdk.common.dkSchemaMapping
Throws:
DKException - - an error occurs in the datastore

add

public void add()
         throws DKException,
                java.lang.Exception

update

public void update()
            throws DKException,
                   java.lang.Exception

del

public void del()
         throws DKException,
                java.lang.Exception

getAttrMappingByMappedName

public dkAttrMapping getAttrMappingByMappedName(java.lang.String mappedAttrName)
                                         throws DKException
Gets attribute mapping object by the given the mapped attribute name.
Specified by:
getAttrMappingByMappedName in interface dkSchemaMapping
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.
Specified by:
getAttrMappingByMapToName in interface dkSchemaMapping
Returns:
attribute mapping object.

setDatastore

public void setDatastore(dkDatastore ds)

getExtension

public com.ibm.mm.sdk.internal.PSchemaMappingExtFed getExtension()

setExtension

public void setExtension(com.ibm.mm.sdk.internal.PSchemaMappingExtFed smext)

isAssocEntityTextSearchable

public boolean isAssocEntityTextSearchable()
                                    throws DKException,
                                           java.lang.Exception
Check to see if associated entity is text searchable
Specified by:
isAssocEntityTextSearchable in interface dkSchemaMapping
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
Specified by:
setAssocEntityTextSearchable in interface dkSchemaMapping

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clears all current cache data
Specified by:
clearCache in interface dkSchemaMapping

EIP Java APIs

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