Package io.goobi.viewer.model.iiif.presentation.v2.builder

Class AbstractAnnotationBuilder

java.lang.Object

io.goobi.viewer.model.iiif.presentation.v2.builder.AbstractAnnotationBuilder

Direct Known Subclasses:

OpenAnnotationBuilder, WebAnnotationBuilder

public class AbstractAnnotationBuilder
extends Object

Author:

florian

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	UGC_SOLR_FIELDS

Constructor Summary

Constructors

Constructor	Description
AbstractAnnotationBuilder(AbstractApiUrlManager urls)

Method Summary

Modifier and Type	Method	Description
Optional<de.intranda.api.annotation.IAnnotation>	getAnnotation(String idString)
long	getAnnotationCount(jakarta.servlet.http.HttpServletRequest request)
Optional<org.apache.solr.common.SolrDocument>	getAnnotationDocument(long id, jakarta.servlet.http.HttpServletRequest request)
List<org.apache.solr.common.SolrDocument>	getAnnotationDocuments(String query, int first, int rows, List<StringPair> sortFields, jakarta.servlet.http.HttpServletRequest request)
List<org.apache.solr.common.SolrDocument>	getAnnotationDocuments(String query, jakarta.servlet.http.HttpServletRequest request)
List<org.apache.solr.common.SolrDocument>	getAnnotationDocuments(String query, List<StringPair> sortFields, jakarta.servlet.http.HttpServletRequest request)
String	getAnnotationQuery()
String	getAnnotationQuery(long id)	Search for both UGC docs with given IDDOC and with MD_ANNOTATION_ID = "annotation_".
String	getAnnotationQuery(String pi)
String	getAnnotationQuery(String pi, int pageNo)
protected AbstractBuilder	getRestBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UGC_SOLR_FIELDS

protected static final String[] UGC_SOLR_FIELDS

Constructor Details

AbstractAnnotationBuilder

public AbstractAnnotationBuilder(AbstractApiUrlManager urls)

Method Details

getAnnotationQuery

public String getAnnotationQuery()

getAnnotationQuery

public String getAnnotationQuery(String pi)

getAnnotationQuery

public String getAnnotationQuery(String pi,
 int pageNo)

getAnnotationQuery

public String getAnnotationQuery(long id)

Search for both UGC docs with given IDDOC and with MD_ANNOTATION_ID = "annotation_". Searching for IDDOC is only included for backwards compatibility purposes. The correct identifier is MD_ANNOTATION_ID since it reflects the original sql identifier

Parameters:

id -

Returns:

Generated query

getAnnotationDocuments

public List<org.apache.solr.common.SolrDocument> getAnnotationDocuments(String query,
 jakarta.servlet.http.HttpServletRequest request)
                                                                 throws PresentationException,
IndexUnreachableException

Parameters:

query -

request -

Returns:

List

Throws:

PresentationException

IndexUnreachableException

getAnnotationDocuments

public List<org.apache.solr.common.SolrDocument> getAnnotationDocuments(String query,
 List<StringPair> sortFields,
 jakarta.servlet.http.HttpServletRequest request)
                                                                 throws PresentationException,
IndexUnreachableException

Parameters:

query -

sortFields -

request -

Returns:

List

Throws:

PresentationException

IndexUnreachableException

getAnnotationDocuments

public List<org.apache.solr.common.SolrDocument> getAnnotationDocuments(String query,
 int first,
 int rows,
 List<StringPair> sortFields,
 jakarta.servlet.http.HttpServletRequest request)
                                                                 throws PresentationException,
IndexUnreachableException

Parameters:

query -

first -

rows -

sortFields -

request -

Returns:

List

Throws:

PresentationException

IndexUnreachableException

getAnnotationDocument

public Optional<org.apache.solr.common.SolrDocument> getAnnotationDocument(long id,
 jakarta.servlet.http.HttpServletRequest request)
                                                                    throws PresentationException,
IndexUnreachableException

Parameters:

id -

request -

Returns:

Optional

Throws:

PresentationException

IndexUnreachableException

getAnnotationCount

public long getAnnotationCount(jakarta.servlet.http.HttpServletRequest request)
                        throws PresentationException,
IndexUnreachableException

Parameters:

request -

Returns:

Annotation count

Throws:

PresentationException

IndexUnreachableException

getRestBuilder

protected AbstractBuilder getRestBuilder()

getAnnotation

public Optional<de.intranda.api.annotation.IAnnotation> getAnnotation(String idString)

Parameters:

idString -

Returns:

Optional