Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Code Block
languagecpp
themeConfluence
FUNCTION xpxDefinePersistentAttrHashTableBNEXxpxDefinePersistentAttrHashTableBNEx (schemaName     : STRING;
                                               entityNames    : AGGREGATE OF STRING;
                                               attributeName  : STRING;
                                               options        : INTEGER;
                                               hashTableWidth : INTEGER;
                                                stringLength   : INTEGER)
                                               status         : INTEGER;   

Use this function to ....

Arguments

Insert excerptUS:_a_schemaNameUS:_a_schemaNamenopaneltrue Insert excerptUS:_a_entityNamesUS:_a_entityNamesnopaneltrue Insert excerptUS:_a_attributeNameUS:_a_attributeNamenopaneltrue Insert excerptUS:_a_options_XPXUS:_a_options_XPXnopaneltrue Insert excerptUS:_a_hashTableWidthUS:_a_hashTableWidthnopaneltrue Insert excerptUS:_a_stringLengthUS:_a_stringLengthnopaneltrueFunction to define an new EDMpersitentAttrHashTable. This function can also be used to delete or redefine an existing EDMpersitentAttrHashTable. This function has variable number of arguments, i.e., it can be invoked with minimum 3 arguments and maximum 6 arguments.

Info

This xpxDefinePersistentAttrHashTableBNEx() function can define EDMpersitentAttrHashTables that are valid for a given set of entities (instance types). The fucnctions xpxDefinePersistentAttrHashTable() and xpxDefinePersistentAttrHashTableBN() can only define EDMpersitentAttrHashTables that are valid for one entity or one entity and all its subtypes.

 

Arguments

...

 

1 TypeNameComment 
2STRINGschemaName

The name of an EXPRESS schema in the EDMdatabase that locates the actual EDMpersitentAttrHashTable. The combination of the attributes "schemaName","entityNames" and "attributeName" uniquely identifies an EDMperistentAttrHashTable in an EDMdatabase.

3AGGREGATE OF STRINGentityNamesAn aggregate (aggregateId) with one or more entity names that defines the actual instance types for the actual EDMpersitentAttrHashTable. All these entities must be in a subtype/supertype relation with each other and they must all be defined in the EXPRESS schema specified in the"schemaName" argument.
4STRINGattributeNameThe name of an attribute that is common for all entities in the "entityNames" aggregate. This attribute must be an explicit attribute of data type STRING.
5INTEGERoptionsOptional value. Default value is INDETERMINATE (?)
6INTEGERhashTableWidthOptional argument. Default value is INDETERMINATE (?). For future extension, i.e., currently a dummy argument.
7INTEGERstringLengthOptiona argument. Default value is  INDETERMINATE (?). This argument sefines the fixed length or the maximum length of the string attributes in the actual EDMpersistentAttrHashTable. This argument must be specified when one of the options xpxFIXED_STRING_LENGTH or xpxMAX_STRING_LENGTH is set.

Return Value

...

Insert excerpt
US:_r_XPX_Return_Value
US:_r_XPX_Return_Value
nopaneltrue

Options

...

 OptionComment
xpxDELETE_ATTRIBUTE_HASH_TABLEDelete the specified EDMpersistentAttrHashTable.
xpxREDEFINE_ATTRIBUTE_HASH_TABLEIf the actual EDMpersistentAttrHashTable already exists, it will be redefined with new properties according to the specification in the actual xpxDefinePersistentAttrHashTableBNEx() operation.
xpxSUBTYPESThe EDMpersistentAttrHashTable will be valid for all subtype instances of the given given entities in the "entityNames" argument.
xpxUNIQUE_ATTRIBUTE_VALUESAll values of the given attribute in the "attributeName" argument must be unique., i.e., no duplicated values are permitted.
xpxFIXED_STRING_LENGTH

All strings in the actual EDMpersistentAttrHashTable must have a fixed length. This length is specified in the "stringLength" argument. This options improve the performance of searching the actual EDMpersistentAttrHashTable.

xpxMAX_STRING_LENGTH

The length of all strings in the actual EDMpersistentAttrHashTable must be less or equal to the length specified in the "stringLength" argument. This options improve the performance of searching the actual EDMpersistentAttrHashTable.

 

Example

...

<example missing>

...