Index

dkSchemaMapping

Purpose:

dkSchemaMapping is an interface to define an associative mapping between a mapped or federated entity and a map-to or native entity in content server datastores.

Class summary:

 class dkSchemaMapping
 {
   public:
    virtual ~dkSchemaMapping();
    virtual DKString getName();
    virtual void setName(const char* name);
    virtual DKString getServerName();
    virtual void setServerName(const char* serverName);
    virtual DKString getServerType();
    virtual void setServerType(const char* serverType);
    virtual DKString getEntityName();
    virtual void setEntityName(const char* nativeEntityName);
    virtual DKString getMappedEntityName();
    virtual void setMappedEntityName(const char* mappedEntityName);
    virtual DKString getMappedEntityType();
    virtual void setMappedEntityType(const char* mappedEntityType);
    virtual DKString getAssocMappedEntityName();
    virtual void setAssocMappedEntityName(const char* name);
    virtual DKString getAssocEntityName();
    virtual void setAssocEntityName(const char* name);
    virtual DKString getAssocServerName();
    virtual void setAssocServerName(const char* name);
    virtual void addAttrMapping(dkAttrMapping* attrMapping);
    virtual void removeAttrMapping(const char* attrMappingName);
    virtual dkAttrMapping* getAttrMapping(const char* attrMappingName);
    virtual dkCollection* listAttrMappings();
    virtual DKString* listAttrMappingNames(long& arraySize);
    virtual void retrieve();
    virtual void update();
    virtual void add();
    virtual void del();
    virtual dkAttrMapping* getAttrMappingByMappedName(const char* mappedAttrName);
    virtual dkAttrMapping* getAttrMappingByMapToName(const char* mapToAttrName);
    virtual DKBoolean isAssocEntityTextSearchable();
    virtual void setAssocEntityTextSearchable(DKBoolean isTextSearchable);
    virtual void clearCache();
   };

Members:

Member functions

getName
Gets the name of this schema mapping object.
virtual DKString getName();

setName
Sets the name of this schema mapping object.
virtual void setName(const char* name);

getServerName
Gets the name of the server where native attributes are defined.
public abstract String getServerName()

setServerName
Sets the name of the server where native attributes are defined.
virtual DKString getServerName();

getServerType
Gets the type of the server where native attributes are defined, such as DK_DL_DSTYPE, DK_OD_DSTYPE, and so forth.
virtual DKString getServerType();

setServerType
Sets the type of the server where native attributes are defined.
virtual void setServerType(const char* serverType);

getEntityName
Gets the name of the native entity. This could be the item type name if the server type (or datastore) is Content Manager, or it could be the application group name if the server type is OnDemand.
virtual DKString getEntityName();

setEntityName
Sets the name of the native entity.
virtual void setEntityName(const char* nativeEntityName);

getMappedEntityName
Gets the name of the mapped or federated entity.
virtual DKString getMappedEntityName();

setMappedEntityName
Sets the name of the mapped or federated entity.
virtual void setMappedEntityName(const char*  mappedEntityName);

getMappedEntityType
Gets the name of the mapped or federated entity type.
virtual DKString getMappedEntityType();

setMappedEntityType
Sets the name of the mapped or federated entity type.
virtual void setMappedEntityType(const char* mappedEntityType);

getAssocMappedEntityName
Gets the name of the associated mapped or federated entity.
virtual DKString getAssocMappedEntityName();

setAssocMappedEntityName
Sets the name of the associated mapped or federated entity.
virtual void setAssocMappedEntityName(const char* name);

getAssocEntityName
Gets the name of the associated native entity.
virtual DKString getAssocEntityName();

setAssocEntityName
Sets the name of the associated native entity.
virtual void setAssocEntityName(const char* name);

getAssocServerName
Gets the name of the associated server where native attributes are defined.
virtual DKString getAssocServerName();

setAssocServerName
Sets the name of the associated server where native attributes are defined.
virtual void setAssocServerName(const char* name);

addAttrMapping
Adds attribute mapping.
virtual void addAttrMapping(dkAttrMapping* attrMapping);

removeAttrMapping
Deletes attribute mapping.
virtual void removeAttrMapping(const char* attrMappingName);

getAttrMapping
Gets an existing attribute mapping given its name.

Parameters

attrMappingName
The attribute mapping name to be retrieved.
virtual dkAttrMapping* getAttrMapping(const char* attrMappingName);

listAttrMappings
Lists all existing attribute mapping defined in this schema mapping.
virtual dkCollection* listAttrMappings();

listAttrMappingNames
Lists all existing attribute mapping names defined in this schema mapping.
virtual DKString* listAttrMappingNames(long& arraySize);

retrieve
Retrieves this mapping from the federated database.
virtual void retrieve();

update
Updates this mapping in the federated database.
virtual void update();

add
Adds mapping to the federated database.
virtual void add();

del
Deletes mapping from the federated database.
virtual void del();

getAttrMappingByMappedName
Gets attribute mapping object by the given mapped attribute name.
virtual dkAttrMapping* getAttrMappingByMappedName(const char* mappedAttrName);

getAttrMappingByMapToName
Gets attribute mapping object by the given map-to attribute name.
virtual dkAttrMapping* getAttrMappingByMapToName(const char* mapToAttrName);

isAssocEntityTextSearchable
Returns true if Fed entity and backend entity are text searchable.
virtual DKBoolean isAssocEntityTextSearchable();

setAssocEntityTextSearchable
Set to true if Fed entity and backend entity are text searchable.
virtual void setAssocEntityTextSearchable(DKBoolean isTextSearchable);

clearCache
Clears the cache.
virtual void clearCache();

Note:
DKUsageError exception thrown if method is not implemented.

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