Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAttrMappingFed

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

public class DKAttrMappingFed
extends java.lang.Object
implements dkAttrMapping, DKMessageIdFed, DKConstant, java.io.Serializable

DKAttrMappingFed is a specific version of the dkAttrMapping class to define an associative mapping between federated attribute(s) and native attribute(s).

See Also:
Serialized Form

Field Summary
 java.lang.String _fromFcn
           
 java.lang.String _fromPath
           
 java.util.Vector _mapped
           
 java.util.Vector _mapTo
           
 java.lang.String _name
           
 java.lang.String _toFcn
           
 java.lang.String _toPath
           
 
Fields inherited from interface com.ibm.mm.sdk.common.dkAttrMapping
CONVERSION_1_1, CONVERSION_1_M, CONVERSION_M_1, NO_CONVERSION
 
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
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKAttrMappingFed()
           
DKAttrMappingFed(dkSchemaMapping sm)
           
DKAttrMappingFed(java.lang.String name)
           
 
Method Summary
 void add()
           
 void addMappedAttr(dkAttrDef attr)
          Adds a new federated attribute to the current mapping to one or more native attributes
 void addMapToAttr(dkAttrDef attr)
          Adds a native attribute to the current mapping to one or more federated attributes
 short checkConversion()
          Checks the kind of data conversion required for this mapping.
 java.lang.String getFromNative()
          Returns the name of the Java conversion function from native to federated attributes
 java.lang.String getFromNCPath()
          Returns the directory of the Java conversion function from native to federated attributes
 dkAttrDef getMappedAttr()
          Returns the definition of the federated attribute in the current mapping
 dkAttrDef getMappedAttr(short index)
          Returns the definition of the federated attribute pointed to by the index in the current mapping
 java.lang.String getMappedAttrName()
          Returns the name of the federated attribute in the current mapping
 java.lang.String getMappedAttrName(short index)
          Returns the name of the federated attribute pointed to by the index in the current mapping
 dkAttrDef getMapToAttr()
          Returns the definition of the native attribute in the current mapping to one or more federated attributes
 dkAttrDef getMapToAttr(short index)
          Returns the definition of the native attribute indicated by the index in the current mapping to one or more federated attributes
 java.lang.String getMapToAttrName()
          Returns the name of the native attribute in the current mapping to one or more federated attributes
 java.lang.String getMapToAttrName(short index)
          Returns the name of the native attribute indicated by the index in the current mapping to one or more federated attributes
 java.lang.String getName()
          Returns the schema mapping name
 dkSchemaMapping getSchemaMapping()
           
 java.lang.String getToNative()
          Gets the name of the Java conversion function from federated to native attributes.
 java.lang.String getToNCPath()
          Returns the directory of the Java conversion function from federated to native attributes
 java.lang.String[] listMappedAttrNames()
          Lists the names of all federated attributes defined in the current mapping
 java.lang.String[] listMapToAttrNames()
          Lists the names of all native attributes defined in the current mapping
 short numberOfMappedAttr()
          Returns the number of federated attributes in the current mapping
 short numberOfMapToAttr()
          Returns the number of native attributes in the current mapping to one or more federated attributes
 void removeMappedAttr(java.lang.String name)
          Removes an existing federated attribute from the current mapping to one or more native attributes
 void removeMapToAttr(java.lang.String name)
          Removes an existing native attribute from the current mapping to one or more federated attributes.
 void retrieve()
           
 void setExtension(com.ibm.mm.sdk.internal.PSchemaMappingExtFed smext)
           
 void setFromNative(java.lang.String fcn)
          Sets the name of the Java conversion function from native to federated attributes
 void setFromNCPath(java.lang.String path)
          Sets the directory of the Java conversion function from native to federated attributes
 void setName(java.lang.String name)
          set the schema mapping name
 void setToNative(java.lang.String fcn)
          Sets the name of the Java conversion function from federated to native attributes
 void setToNCPath(java.lang.String path)
          Sets the directory of the Java conversion function from federated to native attributes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_name

public java.lang.String _name

_fromFcn

public java.lang.String _fromFcn

_fromPath

public java.lang.String _fromPath

_toFcn

public java.lang.String _toFcn

_toPath

public java.lang.String _toPath

_mapped

public java.util.Vector _mapped

_mapTo

public java.util.Vector _mapTo
Constructor Detail

DKAttrMappingFed

public DKAttrMappingFed()

DKAttrMappingFed

public DKAttrMappingFed(java.lang.String name)

DKAttrMappingFed

public DKAttrMappingFed(dkSchemaMapping sm)
Method Detail

getName

public java.lang.String getName()
Returns the schema mapping name
Specified by:
getName in interface dkAttrMapping

setName

public void setName(java.lang.String name)
set the schema mapping name
Specified by:
setName in interface dkAttrMapping
Parameters:
name - the name you want use

addMappedAttr

public void addMappedAttr(dkAttrDef attr)
                   throws DKException
Adds a new federated attribute to the current mapping to one or more native attributes
Specified by:
addMappedAttr in interface dkAttrMapping
Parameters:
attr - the attribute definition

removeMappedAttr

public void removeMappedAttr(java.lang.String name)
Removes an existing federated attribute from the current mapping to one or more native attributes
Specified by:
removeMappedAttr in interface dkAttrMapping
Parameters:
name - attr the attribute name

numberOfMappedAttr

public short numberOfMappedAttr()
Returns the number of federated attributes in the current mapping
Specified by:
numberOfMappedAttr in interface dkAttrMapping

getMappedAttr

public dkAttrDef getMappedAttr()
Returns the definition of the federated attribute in the current mapping
Specified by:
getMappedAttr in interface dkAttrMapping

getMappedAttr

public dkAttrDef getMappedAttr(short index)
Returns the definition of the federated attribute pointed to by the index in the current mapping
Specified by:
getMappedAttr in interface dkAttrMapping
Parameters:
index - the index of the attribute

getMappedAttrName

public java.lang.String getMappedAttrName()
Returns the name of the federated attribute in the current mapping
Specified by:
getMappedAttrName in interface dkAttrMapping

getMappedAttrName

public java.lang.String getMappedAttrName(short index)
Returns the name of the federated attribute pointed to by the index in the current mapping
Specified by:
getMappedAttrName in interface dkAttrMapping
Parameters:
index - the index of the attribute

listMappedAttrNames

public java.lang.String[] listMappedAttrNames()
Lists the names of all federated attributes defined in the current mapping
Specified by:
listMappedAttrNames in interface dkAttrMapping

addMapToAttr

public void addMapToAttr(dkAttrDef attr)
                  throws DKException
Adds a native attribute to the current mapping to one or more federated attributes
Specified by:
addMapToAttr in interface dkAttrMapping
Parameters:
attr - attribute definition

removeMapToAttr

public void removeMapToAttr(java.lang.String name)
Removes an existing native attribute from the current mapping to one or more federated attributes. If the attribute not found, it won't be removed.
Specified by:
removeMapToAttr in interface dkAttrMapping
Parameters:
name - attribute full qualified name,

numberOfMapToAttr

public short numberOfMapToAttr()
Returns the number of native attributes in the current mapping to one or more federated attributes
Specified by:
numberOfMapToAttr in interface dkAttrMapping

getMapToAttr

public dkAttrDef getMapToAttr()
Returns the definition of the native attribute in the current mapping to one or more federated attributes
Specified by:
getMapToAttr in interface dkAttrMapping

getMapToAttr

public dkAttrDef getMapToAttr(short index)
Returns the definition of the native attribute indicated by the index in the current mapping to one or more federated attributes
Specified by:
getMapToAttr in interface dkAttrMapping
Parameters:
index - the index of the attribute

getMapToAttrName

public java.lang.String getMapToAttrName()
Returns the name of the native attribute in the current mapping to one or more federated attributes
Specified by:
getMapToAttrName in interface dkAttrMapping

getMapToAttrName

public java.lang.String getMapToAttrName(short index)
Returns the name of the native attribute indicated by the index in the current mapping to one or more federated attributes
Specified by:
getMapToAttrName in interface dkAttrMapping
Parameters:
index - the index of the attribute

listMapToAttrNames

public java.lang.String[] listMapToAttrNames()
Lists the names of all native attributes defined in the current mapping
Specified by:
listMapToAttrNames in interface dkAttrMapping

setToNative

public void setToNative(java.lang.String fcn)
Sets the name of the Java conversion function from federated to native attributes
Specified by:
setToNative in interface dkAttrMapping
Parameters:
fcn - name of the function, including the class path

getToNative

public java.lang.String getToNative()
Gets the name of the Java conversion function from federated to native attributes.
Specified by:
getToNative in interface dkAttrMapping

setToNCPath

public void setToNCPath(java.lang.String path)
Sets the directory of the Java conversion function from federated to native attributes
Specified by:
setToNCPath in interface dkAttrMapping
Parameters:
path - the path of the function, including the name

getToNCPath

public java.lang.String getToNCPath()
Returns the directory of the Java conversion function from federated to native attributes
Specified by:
getToNCPath in interface dkAttrMapping

setFromNative

public void setFromNative(java.lang.String fcn)
Sets the name of the Java conversion function from native to federated attributes
Specified by:
setFromNative in interface dkAttrMapping
Parameters:
fcn - name of the function, including the path

getFromNative

public java.lang.String getFromNative()
Returns the name of the Java conversion function from native to federated attributes
Specified by:
getFromNative in interface dkAttrMapping

setFromNCPath

public void setFromNCPath(java.lang.String path)
Sets the directory of the Java conversion function from native to federated attributes
Specified by:
setFromNCPath in interface dkAttrMapping
Parameters:
path - path of the function, including the name

getFromNCPath

public java.lang.String getFromNCPath()
Returns the directory of the Java conversion function from native to federated attributes
Specified by:
getFromNCPath in interface dkAttrMapping

checkConversion

public short checkConversion()
Checks the kind of data conversion required for this mapping.
Specified by:
checkConversion in interface dkAttrMapping
Returns:
a short with the following possible values:
  • dkAttributeMapping.NO_CONVERSION
  • dkAttributeMapping.CONVERSION_1_1
  • dkAttributeMapping.CONVERSION_1_M
  • dkAttributeMapping.CONVERSION_M_1
There is no practical use for M-to-N conversion.

getSchemaMapping

public dkSchemaMapping getSchemaMapping()

setExtension

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

retrieve

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

add

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

EIP Java APIs

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