DocumentIdUtil

  • DocumentIdUtil is a utility class for working with document IDs.

  • It provides methods to generate qualified IDs for documents based on package, database, and either a GenericDocument object or individual namespace and ID strings.

  • A qualified ID is a string representing the combined package name, database name, namespace, and ID of a document, used for linking documents.
public class DocumentIdUtil extends Object

A util class with methods for working with document ids.

Public Method Summary

static String
createQualifiedId(String packageName, String databaseName, GenericDocument document)
Generates a qualified id based on package, database, and a GenericDocument.
static String
createQualifiedId(String packageName, String databaseName, String namespace, String id)
Generates a qualified id based on package, database, namespace, and doc id.

Inherited Method Summary

Public Methods

public static String createQualifiedId (String packageName, String databaseName, GenericDocument document)

Generates a qualified id based on package, database, and a GenericDocument.

Parameters
packageName The package the document belongs to.
databaseName The database containing the document.
document The document to generate a qualified id for.
Returns
  • the qualified id of a document.
See Also

public static String createQualifiedId (String packageName, String databaseName, String namespace, String id)

Generates a qualified id based on package, database, namespace, and doc id.

A qualified id is a String referring to the combined package name, database name, namespace, and id of the document. It is useful for linking one document to another in order to perform a join operation.

Parameters
packageName The package the document belongs to.
databaseName The database containing the document.
namespace The namespace of the document.
id The id of the document.
Returns
  • the qualified id of a document