Class DocumentChecker (2.0.0) 

public final class DocumentChecker

Checks values of a com.google.appengine.api.search.Document.

Inheritance

java.lang.Object > DocumentChecker

Static Methods

checkDocumentId(String documentId)

public static String checkDocumentId(String documentId)

Checks whether a document id is valid. A document id is a non-null ASCII visible printable string of

MAXIMUM_DOCUMENT_ID_LENGTH characters which does not start

with '!' which is reserved for system documents.

Parameter
Name Description
documentId String

the document id to check
Returns
Type Description
String

the checked document id

checkFacetSet(DocumentPb.Document document)

public static void checkFacetSet(DocumentPb.Document document)

Checks validity of facets in document.

Parameter
Name Description
document com.google.apphosting.api.search.DocumentPb.Document

checkFieldSet(DocumentPb.Document document)

public static void checkFieldSet(DocumentPb.Document document)

Checks whether a document's field set is valid. A field set is valid if it does not contain any number, date, or vector fields with the same name.

Parameter
Name Description
document com.google.apphosting.api.search.DocumentPb.Document

the document to check

checkValid(DocumentPb.Document pb)

public static DocumentPb.Document checkValid(DocumentPb.Document pb)

Checks whether a DocumentPb.Document has a valid set of fields.

Parameter
Name Description
pb com.google.apphosting.api.search.DocumentPb.Document

the DocumentPb.Document protocol buffer to check
Returns
Type Description
com.google.apphosting.api.search.DocumentPb.Document

the checked document

getNumberOfSecondsSince()

public static int getNumberOfSecondsSince()
Returns
Type Description
int

the number of seconds since 2011/1/1

Constructors

DocumentChecker()

public DocumentChecker()