This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata

SuperSERVER maintains a separate database for storing annotation information. For details of the database schema and facilities supported by the SuperSERVER annotation subsystem, see Annotations - Data Control API.

The following functions allow access to the annotation facilities within SuperSERVER.

AddSymbolDescriptionT()

Add an annotation symbol and description to the results.

Available To
PrepareJob
PerformJob
CleanUpJob
AddSymbolDescriptionT(JobInfoT* JobInfo, const char* Symbol, const char* Description)
Arguments
JobInfoInputInformation about the current job.
SymbolInputThe symbol (or ID) for the annotation.
DescriptionInputThe annotation description.
Returns
1Success.
0The operation failed. For example because you attempted to add a duplicate symbol.

GetALLSymbolDescriptionT()

Retrieve all annotations.

Available To
PrepareJob
PerformJob
CleanUpJob
GetALLSymbolDescriptionT(JobInfoT* JobInfo, const SymbolDescriptionT** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
ValuesOutputAn array containing the returned annotation symbols and descriptions.
LenOutputThe length of the returned array.
Returns
1Success.
0The operation failed.

If the operation is successful, but the result set is empty, then Len will be set to zero and Values will be NULL.

AddDatabaseAnnotationT()

Assign a database annotation to the tabulation request.

Available To
PrepareJob
PerformJob
CleanUpJob
AddDatabaseAnnotationT(JobInfoT *JobInfo, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
SymbolInputThe symbol for the annotation to assign.
Returns
1Success.
0The operation failed.

DeleteDatabaseAnnotationT()

Delete a database annotation from the tabulation request.

Available To
PrepareJob
PerformJob
CleanUpJob
DeleteDatabaseAnnotationT(JobInfoT *JobInfo, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
SymbolInputThe symbol for the annotation to delete.
Returns
1Success.
0The operation failed.

GetDatabaseAnnotationT()

Retrieve all the database annotations for the tabulation request.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDatabaseAnnotationT(JobInfoT *JobInfo, const char*** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
ValuesOutputAn array of returned values.
LenOutputThe length of the returned results.
Returns
1Success.
0The operation failed.

If the operation is successful, but the result set is empty, then Len will be set to zero and Values will be NULL.

AddFieldAnnotationT()

Assign an annotation to a field.

Available To
PrepareJob
PerformJob
CleanUpJob
AddFieldAnnotationT(JobInfoT *JobInfo, int Dimension, int FieldOffset, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to assign the annotation to.
SymbolInputThe symbol for the annotation to add.
Returns
1Success.
0The operation failed.

DeleteFieldAnnotationT()

Delete an annotation from a field.

Available To
PrepareJob
PerformJob
CleanUpJob
DeleteFieldAnnotationT(JobInfoT *JobInfo, int Dimension, int FieldOffset, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to delete the annotation from.
SymbolInputThe symbol for the annotation to delete.
Returns
1Success.
0The operation failed.

GetFieldAnnotationT()

Retrieve all annotations from a specified field.

Available To
PrepareJob
PerformJob
CleanUpJob
GetFieldAnnotationT(JobInfoT *JobInfo, int Dimension, int FieldOffset, const char*** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to get the annotation for.
ValuesOutputAn array of returned values.
LenOutputThe length of the returned results.
Returns
1Success.
0The operation failed.

If the operation is successful, but the result set is empty, then Len will be set to zero and Values will be NULL.

AddFieldValueAnnotationT()

Assign an annotation to a field value.

Available To
PrepareJob
PerformJob
CleanUpJob
AddFieldValueAnnotationT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension.
WhichItemInputThe index of the item within the field to assign the annotation to.
SymbolInputThe symbol for the annotation to assign.
Returns
1Success.
0The operation failed.

DeleteFieldValueAnnotationT()

Delete an annotation from a field value.

Available To
PrepareJob
PerformJob
CleanUpJob
DeleteFieldValueAnnotationT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension.
WhichItemInputThe index of the item within the field to delete the annotation from.
SymbolInputThe symbol for the annotation to delete.
Returns
1Success.
0The operation failed.

GetFieldValueAnnotationT()

Retrieve all annotations for a field value.

Available To
PrepareJob
PerformJob
CleanUpJob
GetFieldValueAnnotationT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const char*** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension.
WhichItemInputThe index of the item within the field to get the annotations from.
ValuesOutputAn array of returned values.
LenOutputThe length of the returned results.
Returns
1Success.
0The operation failed.

If the operation is successful, but the result set is empty, then Len will be set to zero and Values will be NULL.

AddCurrentCellAnnotationT()

Assign an annotation to the current cell.

Available To
PrepareJob
PerformJob
CleanUpJob
AddCurrentCellAnnotationT(JobInfoT *JobInfo, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
SymbolInputThe annotation symbol to assign.
Returns
1Success.
0The operation failed.

DeleteCurrentCellAnnotationT()

Delete an annotation from the current cell.

Available To
PrepareJob
PerformJob
CleanUpJob
DeleteCurrentCellAnnotationT(JobInfoT *JobInfo, const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
SymbolInputThe annotation symbol to delete.
Returns
1Success.
0The operation failed.

GetCurrentCellAnnotationT()

Get all annotations for the current cell.

Available To
PrepareJob
PerformJob
CleanUpJob
GetCurrentCellAnnotationT(JobInfoT *JobInfo, const char*** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
ValuesOutputAn array of returned values.
LenOutputThe length of the returned results.
Returns
1Success.
0The operation failed.

If the operation is successful, but the result set is empty, then Len will be set to zero and Values will be NULL.

AddCellAnnotationT()

Assign an annotation to a particular cell.

Available To
PrepareJob
PerformJob
CleanUpJob
AddCellAnnotationT(JobInfoT *JobInfo, const int* CellLocation, int Len ,const char* Symbol)
Arguments
JobInfoInputInformation about the current job.
CellLocationInputAn array of dimension item indexes identifying a cell in the data cube.
LenInputThe length of CellLocation.
SymbolInputThe annotation symbol to assign.
Returns
1Success.
0The operation failed.
  • No labels