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.
Modifier and Type | Method and Description |
---|---|
ContentHandlerResult |
getAllAnnotationsForDocument(ContentHandlerInput input)
Returns a map of all of the annotations for a specified document key.
|
ContentHandlerResult getAllAnnotationsForDocument(ContentHandlerInput input) throws VirtualViewerAPIException
input
- ContentHandlerInput containing the following values:
Key | Type | Description |
---|---|---|
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(); |
Key | Type | Description |
---|---|---|
KEY_ALL_ANNOTATIONS_HASH | java.util.Map | Map of string annotation layer keys to their AnnotationLayer objects. |
VirtualViewerAPIException
- if content handler throws exceptionAnnotationsInterface.getAnnotationContent(com.snowbound.contenthandler.ContentHandlerInput)
Copyright © 2020 Snowbound Software Corporation. All rights reserved.