Data Cube Associations

Tabulation results are stored in a data cube. The cross tabulation cube can be associated with other results, such as frequency of contributors and first N largest contributors.

The associations between the cross tabulation cube and others are determined by association names.

For example:

DC-API-Cube-Relationships.png

 

AddAssociationT()

Add multiple association cubes to a job.

Available To

PrepareJob

PerformJob

CleanUpJob


C++
AddAssociationT(JobInfoT *JobInfo, const char* AssociationName, int Num)


Arguments


JobInfo

Input

Information about the current job.

AssociationName

Input

The name of a result, such as FREQ, TOPN, CONCEALMENT, CELL_ERRORS.

Num

Input

The number of the association.


Returns


1

Success.

0

Failed.


GetAssociationNamesT()

Retrieve the names of the associations that exist in a job.

Available To

PrepareJob

PerformJob

CleanUpJob


C++
GetAssociationNamesT(JobInfoT* JobInfo,int* Len)


Arguments


JobInfo

Input

Information about the current job.

Len

Output

The number of associations.


Returns

 An array containing the association names, or NULL if there are no associations.

GetNumOfAssociatedCubeT()

Retrieve the number of associated results for a tabulation result. Depending on the type of the association, there may be multiple values for the association name.

For example:

  • ASSOCATION_FREQ will have a single associated value for each cell in the cube.

  • ASSOCIATION_TOPN will have multiple associated values determined by the value of 'N' specified in the SuperADMIN properties when the requesting module was configured.

Available To

PrepareJob

PerformJob

CleanUpJob


C++
GetNumOfAssociatedCubeT(JobInfoT *JobInfo, const char* AssociationName)


Arguments


JobInfo

Input

Information about the current job.

AssociationName

Input

The name of an association.


Returns

 The number of associated cubes, or 0 if the requested association does not exist.

DoesAssociationExistT()

Query the existence of an association for a tabulation result.

Available To

PrepareJob

PerformJob

CleanUpJob


C++
DoesAssociationExistT(JobInfoT* JobInfo, const char* AssociationName)


Arguments


JobInfo

Input

Information about the current job.

AssociationName

Input

The name of an association.


Returns


1

The association exists.

0

The association does not exist.


DoesNthAssociationExistT()

Query the existence of an nth association result for a given association.

Associations such as TOPN can have multiple associated values for the same association name.

Available To

PrepareJob

PerformJob

CleanUpJob


C++
DoesNthAssociationExistT(JobInfoT* JobInfo, const char* AssociationName,int Pos)


Arguments


JobInfo

Input

Information about the current job.

ResultName

Input

The name of an association result.

Pos

Input

The result position to query.


Returns


1

The association exists.

0

The association does not exist.


DuplicateTabulationCubeT()

Duplicate the cross tabulation cube and give the duplicate a name. The name can be used to retrieve/access the duplicated cube.

Available To

PrepareJob

PerformJob

CleanUpJob


C++
DuplicateTabulationCubeT(JobInfoT *JobInfo, const char* AssociationName)


Arguments


JobInfo

Input

Information about the current job.

AssociationName

Input

The name of an association.


Returns


1

Cells are available.

0

No cells are available.