Package com.snowbound.contenthandler.interfaces

Interface AllAnnotationsInterface

  • All Known Implementing Classes:
    FileContentHandler, RestfulHttpContentHandler
    public interface AllAnnotationsInterface

    This interface defines a more efficient method for retrieving annotations on a document. getAllAnnotations allows retrieving all annotations on a document, rather than one annotation at a time as for getAnnotationContent.

    If AllAnnotationsInterface is implemented on a content handler, getAllAnnotationsForDocument will be used instead of getAnnotationContent for most annotation retrieval.

    • Method Detail

      • getAllAnnotationsForDocument

        ContentHandlerResult getAllAnnotationsForDocument​(ContentHandlerInput input)
                                           throws VirtualViewerAPIException
        Returns a map of all of the annotations for a specified document key.
        Parameters:
        input -

        ContentHandlerInput containing the following values:

        Every row is an expected value in the ContentHandlerInput. The first column is the string key for the value. The second column is the type of the value. The third column is the detailed description of the value.
        KeyTypeDescription
        KEY_DOCUMENT_ID java.lang.String The key representing the document. Can be retrieved with String documentId = input.getDocumentId();
        KEY_CLIENT_INSTANCE_ID java.lang.String Custom configurable value used to pass data from client to content handler. If not set then will be set to the session ID. Can be retrieved with String clientInstanceId = input.getClientInstanceId();
        KEY_HTTP_SERVLET_REQUEST javax.servlet.http.HttpServletRequest Request that called this method. Can be retrieved with HttpServletRequest request = input.getHttpServletRequest();
        Returns:
        ContentHandlerResult with the following values:
        Every row is an expected value in the ContentHandlerResult. The first column is the string key for the value. The second column is the type of the value. The third column is the detailed description of the value.
        KeyTypeDescription
        KEY_ALL_ANNOTATIONS_HASH java.util.Map Map of string annotation layer keys to their AnnotationLayer objects.
        Throws:
        VirtualViewerAPIException - if content handler throws exception
        See Also:
        AnnotationsInterface.getAnnotationContent(com.snowbound.contenthandler.ContentHandlerInput)