|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public java.lang.String getName()
public void setName(java.lang.String name)
extName
- name of this SchemaMapping objectpublic java.lang.String getServerName()
public void setServerName(java.lang.String serverName)
serverName
- back-end server namepublic java.lang.String getServerType()
public void setServerType(java.lang.String serverType)
serverType
- server typepublic java.lang.String getEntityName()
public void setEntityName(java.lang.String nativeEntityName)
nativeEntityName
- name of the native entity (index class name
for example)public java.lang.String getMappedEntityName()
public void setMappedEntityName(java.lang.String mappedEntityName)
mappedEntityName
- federated entity namepublic short getMappedEntityType()
public void setMappedEntityType(short mappedEntityType)
mappedEntityName
- federated entity typepublic java.lang.String getAssocMappedEntityName()
public void setAssocMappedEntityName(java.lang.String assocMappedEntityName)
mappedEntityName
- associated federated entity namepublic java.lang.String getAssocEntityName()
public void setAssocEntityName(java.lang.String assocNativeEntityName)
nativeEntityName
- name of the associated native entity (index class name
for example)public java.lang.String getAssocServerName()
public void setAssocServerName(java.lang.String assocServerName)
serverName
- back-end associated server namepublic dkAttrMapping getAttrMapping(java.lang.String attrMappingName) throws DKException
attrMappingName
- federated entity mapping name to be retrievedDKException
- - an error occurs in the datastorepublic dkCollection listAttrMappings() throws DKException
DKException
- - an error occurs in the datastorepublic java.lang.String[] listAttrMappingNames() throws DKException
DKException
- - an error occurs in the datastorepublic void retrieve() throws DKException, java.lang.Exception
DKException
- - an error occurs in the datastorepublic dkAttrMapping getAttrMappingByMappedName(java.lang.String mappedAttrName) throws DKException
public dkAttrMapping getAttrMappingByMapToName(java.lang.String mapToAttrName) throws DKException
public boolean isAssocEntityTextSearchable() throws DKException, java.lang.Exception
public void setAssocEntityTextSearchable(boolean isTextSearchable) throws DKException, java.lang.Exception
public void clearCache() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |