Uses of Class
io.goobi.viewer.model.viewer.StructElement

Packages that use StructElement

Package	Description
io.goobi.viewer.api.rest.filters
io.goobi.viewer.api.rest.resourcebuilders
io.goobi.viewer.controller.imaging
io.goobi.viewer.managedbeans
io.goobi.viewer.model.cms.collections
io.goobi.viewer.model.cms.itemfunctionality
io.goobi.viewer.model.crowdsourcing
io.goobi.viewer.model.iiif.presentation.v2.builder
io.goobi.viewer.model.iiif.presentation.v3.builder
io.goobi.viewer.model.maps
io.goobi.viewer.model.metadata
io.goobi.viewer.model.search
io.goobi.viewer.model.toc
io.goobi.viewer.model.viewer
io.goobi.viewer.model.viewer.pageloader
io.goobi.viewer.servlets.oembed
io.goobi.viewer.solr

Uses of StructElement in io.goobi.viewer.api.rest.filters

Methods in io.goobi.viewer.api.rest.filters that return types with arguments of type StructElement

Modifier and Type	Method	Description
Optional<StructElement>	ImageInformationFilter.getStructElement(String pi)	getStructElement.

Uses of StructElement in io.goobi.viewer.api.rest.resourcebuilders

Methods in io.goobi.viewer.api.rest.resourcebuilders with parameters of type StructElement

Modifier and Type	Method	Description
String	RisResourceBuilder.getRIS(StructElement se)
javax.ws.rs.core.StreamingOutput	RisResourceBuilder.writeRIS(StructElement se)

Uses of StructElement in io.goobi.viewer.controller.imaging

Methods in io.goobi.viewer.controller.imaging with parameters of type StructElement

Modifier and Type	Method	Description
String	ThumbnailHandler.getAnchorImagePath(StructElement doc, String thumbnailUrl, String anchorThumbnailMode)
String	ThumbnailHandler.getCMSPageImagePath(StructElement doc, String thumbnailUrl)
String	ThumbnailHandler.getDocStructImagePath(StructElement doc, String thumbnailUrl)
String	ThumbnailHandler.getDocumentImagePath(StructElement doc, String thumbnailUrl)
Optional<String>	WatermarkHandler.getFooterIdIfExists(StructElement topDocument)	Return the watermark id for the given StructElement
String	PdfHandler.getPdfUrl(StructElement doc, PhysicalElement page)	Return the pdf-download url for the given StructElement and PhysicalElement
String	PdfHandler.getPdfUrl(StructElement se, PhysicalElement[] pages)	Return the pdf-download url for the given StructElement and a number of PhysicalElements
String	PdfHandler.getPdfUrl(StructElement doc, String label)	Gets the url to the pdf for the given StructElement.
String	PdfHandler.getPdfUrl(StructElement doc, String pi, String label)	Gets the url to the pdf for the given pi and divId
String	ThumbnailHandler.getSquareThumbnailUrl(StructElement se)	returns a link the an image representing the given document.
String	ThumbnailHandler.getSquareThumbnailUrl(StructElement se, int size)	returns a link the an image representing the given document of the given size.
String	ThumbnailHandler.getThumbnailUrl(StructElement doc)	Returns a link to a small image representing the given document.
String	ThumbnailHandler.getThumbnailUrl(StructElement se, int width, int height)	Returns a link to an image representing the given document of the given size (to be exact: the largest image size which fits within the given bounds and keeps the image proportions
String	ThumbnailHandler.getThumbnailUrl(StructElement doc, String pi)	Returns a link to a small image representing the given document with the given pi.
String	ThumbnailHandler.getThumbnailUrl(StructElement doc, String pi, int width, int height)	getThumbnailUrl.
Optional<String>	WatermarkHandler.getWatermarkTextIfExists(StructElement doc)	Optionally returns the watermark text for the given pi.

Uses of StructElement in io.goobi.viewer.managedbeans

Methods in io.goobi.viewer.managedbeans that return StructElement

Modifier and Type	Method	Description
StructElement	ActiveDocumentBean.getCurrentElement()	getCurrentElement.
StructElement	SearchBean.getStructElement(String pi)	getStructElement.
StructElement	ActiveDocumentBean.getTopDocument()	getTopDocument.

Methods in io.goobi.viewer.managedbeans with parameters of type StructElement

Modifier and Type	Method	Description
String	TextBean.getAbstract(StructElement topDocument, String language)	Returns the abstract portion of the TEI document, converting TEI markup to HTML.
String	TextBean.getAbstract(StructElement topDocument, String abstractType, String language)	Returns the abstract portion of the given type of the TEI document, converting TEI markup to HTML.
String	TextBean.getAbstractSchoolbook(StructElement topDocument, String language)	Returns the schoolbook abstract portion of the TEI document, converting TEI markup to HTML.
List<String>	TextBean.getRecordLanguages(StructElement topDocument)
String	TextBean.getTeiText(StructElement topDocument, String language)	Loads and returns the TEI text for the given record and language if full-text access is granted to the client.

Uses of StructElement in io.goobi.viewer.model.cms.collections

Methods in io.goobi.viewer.model.cms.collections that return types with arguments of type StructElement

Modifier and Type	Method	Description
Optional<StructElement>	CMSCollection.getRepresentativeWork()	getRepresentativeWork.

Uses of StructElement in io.goobi.viewer.model.cms.itemfunctionality

Methods in io.goobi.viewer.model.cms.itemfunctionality that return StructElement

Modifier and Type	Method	Description
StructElement	TocFunctionality.getDocStruct()	Getter for the field docStruct.

Uses of StructElement in io.goobi.viewer.model.crowdsourcing

Methods in io.goobi.viewer.model.crowdsourcing with parameters of type StructElement

Modifier and Type	Method	Description
static String	DisplayUserGeneratedContent.generateAddressLabel(StructElement se, String text)
static String	DisplayUserGeneratedContent.generateCorporationLabel(StructElement se)
static String	DisplayUserGeneratedContent.generatePersonLabel(StructElement se)
static String	DisplayUserGeneratedContent.generateUgcLabel(StructElement se)	Builds label out of user-generated content metadata.

Uses of StructElement in io.goobi.viewer.model.iiif.presentation.v2.builder

Methods in io.goobi.viewer.model.iiif.presentation.v2.builder that return StructElement

Modifier and Type	Method	Description
StructElement	AbstractBuilder.getDocument(String pi)	getDocument.

Methods in io.goobi.viewer.model.iiif.presentation.v2.builder that return types with arguments of type StructElement

Modifier and Type	Method	Description
List<StructElement>	AbstractBuilder.getDocumentWithChildren(String pi)	Queries all DocStructs which have the given PI as PI_TOPSTRUCT or anchor (or are the anchor themselves).

Methods in io.goobi.viewer.model.iiif.presentation.v2.builder with parameters of type StructElement

Modifier and Type	Method	Description
Map<de.intranda.api.iiif.presentation.enums.AnnotationType,List<de.intranda.api.iiif.presentation.v2.AnnotationList>>	SequenceBuilder.addBaseSequence(de.intranda.api.iiif.presentation.v2.Manifest2 manifest, StructElement doc, String manifestId, List<Integer> pagesToInclude, javax.servlet.http.HttpServletRequest request)	Creates a sequence from all pages within the given doc and appends it to manifest
void	AbstractBuilder.addMetadata(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, StructElement ele)	addMetadata.
Map<de.intranda.api.iiif.presentation.enums.AnnotationType,de.intranda.api.iiif.presentation.v2.AnnotationList>	SequenceBuilder.addOtherContent(StructElement doc, PhysicalElement page, de.intranda.api.iiif.presentation.v2.Canvas2 canvas, boolean populate)	addOtherContent.
void	ManifestBuilder.addRenderings(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, StructElement ele, Optional<PhysicalElement> page)
void	StructureBuilder.addRenderings(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 range, StructElement ele)
void	ManifestBuilder.addSeeAlsos(de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, StructElement ele)
int	StructElementComparator.compare(StructElement ds1, StructElement ds2)
de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2	ManifestBuilder.generateManifest(StructElement ele, List<Integer> pagesToInclude)	generateManifest.
protected Optional<de.intranda.metadata.multilanguage.IMetadataValue>	AbstractBuilder.getDescription(StructElement ele)	getDescription.
protected Optional<de.intranda.metadata.multilanguage.IMetadataValue>	AbstractBuilder.getLabel(StructElement ele)	getDescription.
String	AbstractBuilder.getLidoResolverUrl(StructElement ele)	getLidoResolverUrl.
String	AbstractBuilder.getMetsResolverUrl(StructElement ele)	getMetsResolverUrl.
PhysicalElement	SequenceBuilder.getPage(StructElement doc, int order)	getPage.
void	ManifestBuilder.populate(StructElement ele, de.intranda.api.iiif.presentation.v2.AbstractPresentationModelElement2 manifest, List<PhysicalElement> pages)	populate.
void	StructureBuilder.populate(StructElement ele, String pi, de.intranda.api.iiif.presentation.v2.Range2 range)	Adds Metadata and links to external services to a range
void	StructureBuilder.populatePages(StructElement doc, String pi, de.intranda.api.iiif.presentation.v2.Range2 range)	populatePages.

Method parameters in io.goobi.viewer.model.iiif.presentation.v2.builder with type arguments of type StructElement

Modifier and Type	Method	Description
protected void	AbstractBuilder.addEventMetadataToWorkElement(List<StructElement> eles, List<org.apache.solr.common.SolrDocument> events)	Adds all metadata from the given events to the first work document contained in eles.
void	ManifestBuilder.addVolumes(de.intranda.api.iiif.presentation.v2.Collection2 anchor, List<StructElement> volumes)	addVolumes.
List<de.intranda.api.iiif.presentation.v2.Range2>	StructureBuilder.generateStructure(List<StructElement> elements, String pi, boolean useMembers)	Generates the topmost range from the given elements.

Uses of StructElement in io.goobi.viewer.model.iiif.presentation.v3.builder

Methods in io.goobi.viewer.model.iiif.presentation.v3.builder that return StructElement

Modifier and Type	Method	Description
StructElement	DataRetriever.getDocument(String pi)	getDocument.

Methods in io.goobi.viewer.model.iiif.presentation.v3.builder that return types with arguments of type StructElement

Modifier and Type	Method	Description
List<StructElement>	DataRetriever.getContainedRecords(String solrField, String collectionName)	Get all records directly belonging to the given collection, only the fields in DataRetriever.CONTAINED_WORKS_QUERY_FIELDS are returned
List<StructElement>	DataRetriever.getDocumentWithChildren(String pi)	Queries all DocStructs which have the given PI as PI_TOPSTRUCT or anchor (or are the anchor themselves).

Methods in io.goobi.viewer.model.iiif.presentation.v3.builder with parameters of type StructElement

Modifier and Type	Method	Description
void	AbstractBuilder.addMetadata(de.intranda.api.iiif.presentation.v3.AbstractPresentationModelElement3 manifest, StructElement ele)	addMetadata.
void	ManifestBuilder.addPage(de.intranda.api.iiif.presentation.v3.Manifest3 manifest, StructElement ele, int pageNo)
de.intranda.api.iiif.presentation.v3.Range3	RangeBuilder.build(StructElement topElement, List<StructElement> structures, String logId)
int	StructElementComparator.compare(StructElement ds1, StructElement ds2)
protected de.intranda.api.iiif.presentation.v3.Collection3	AbstractBuilder.createAnchorLink(StructElement rec)
protected de.intranda.api.iiif.presentation.v3.Manifest3	AbstractBuilder.createRecordLink(StructElement rec)
protected Optional<de.intranda.metadata.multilanguage.IMetadataValue>	AbstractBuilder.getDescription(StructElement ele)	getDescription.
protected Optional<de.intranda.metadata.multilanguage.IMetadataValue>	AbstractBuilder.getLabel(StructElement ele)	getDescription.
URI	AbstractBuilder.getLidoResolverUrl(StructElement ele)	getLidoResolverUrl.
URI	AbstractBuilder.getMetsResolverUrl(StructElement ele)	getMetsResolverUrl.
protected Optional<URI>	AbstractBuilder.getRightsStatement(StructElement ele)
protected Optional<String>	AbstractBuilder.getSolrFieldValue(StructElement ele, String fieldName)
protected de.intranda.api.annotation.wa.ImageResource	AbstractBuilder.getThumbnail(StructElement ele)
protected de.intranda.api.annotation.wa.ImageResource	AbstractBuilder.getThumbnail(StructElement ele, int pageNo)

Method parameters in io.goobi.viewer.model.iiif.presentation.v3.builder with type arguments of type StructElement

Modifier and Type	Method	Description
protected void	DataRetriever.addEventMetadataToWorkElement(List<StructElement> eles, List<org.apache.solr.common.SolrDocument> events)	Adds all metadata from the given events to the first work document contained in eles.
de.intranda.api.iiif.presentation.v3.Range3	RangeBuilder.build(StructElement topElement, List<StructElement> structures, String logId)

Uses of StructElement in io.goobi.viewer.model.maps

Constructors in io.goobi.viewer.model.maps with parameters of type StructElement

Modifier	Constructor	Description
	RecordGeoMap(StructElement struct, List<MetadataContainer> relatedDocuments)	Create a new geomap with features from the given StructElement and related documents.
	RecordGeoMap(StructElement struct, List<MetadataContainer> relatedDocuments, IDAO dao, List<FeatureSetConfiguration> featureSetConfigs)	Create a new geomap with features from the given StructElement and related documents.

Uses of StructElement in io.goobi.viewer.model.metadata

Methods in io.goobi.viewer.model.metadata with parameters of type StructElement

Modifier and Type	Method	Description
static String	MetadataTools.generateDublinCoreMetaTags(StructElement structElement)	generateDublinCoreMetaTags.
static String	MetadataTools.generateHighwirePressMetaTags(StructElement structElement, List<PhysicalElement> pages)	generateHighwirePressMetaTags.
static String	MetadataTools.generateRIS(StructElement se)	generateRIS.
MetadataElement	MetadataElement.init(StructElement se, int metadataViewIndex, Locale sessionLocale)
boolean	MetadataView.isVisible(StructElement se)	Checks link visibility conditions.
boolean	Metadata.populate(StructElement se, String ownerIddoc, List<StringPair> sortFields, Locale locale)	Populates the parameters of the given metadata with values from the given StructElement.

Constructors in io.goobi.viewer.model.metadata with parameters of type StructElement

Modifier	Constructor	Description
	VariableReplacer(StructElement metadataContainer)

Uses of StructElement in io.goobi.viewer.model.search

Methods in io.goobi.viewer.model.search with parameters of type StructElement

Modifier and Type	Method	Description
de.intranda.metadata.multilanguage.IMetadataValue	BrowseElement.createMultiLanguageLabel(StructElement structElement)	createMultiLanguageLabel.
HitType	SearchHitFactory.getHitType(HitType overrideType, StructElement se, String docType)

Uses of StructElement in io.goobi.viewer.model.toc

Methods in io.goobi.viewer.model.toc with parameters of type StructElement

Modifier and Type	Method	Description
void	TOC.generate(StructElement structElement, boolean addAllSiblings, String mimeType, int tocCurrentPage)	generate.
static Map<String,List<TOCElement>>	TocMaker.generateToc(TOC toc, StructElement structElement, boolean addAllSiblings, String mimeType, int tocCurrentPage, int hitsPerPage)	Generate the TOC.

Uses of StructElement in io.goobi.viewer.model.viewer

Methods in io.goobi.viewer.model.viewer that return StructElement

Modifier and Type	Method	Description
static StructElement	StructElement.create(org.apache.solr.common.SolrDocument solrDoc)
StructElement	ViewManager.getCurrentStructElement()	Getter for the field currentStructElement.
StructElement	StructElement.getFirstVolume(List<String> fields)	getFirstVolume.
StructElement	StructElement.getParent()	Loads and returns the immediate parent StructElement of this element.
StructElement	StructElement.getTopStruct()	Returns a StructElement that represents the top non-anchor element of the hierarchy (ISWORK=true).
StructElement	ViewManager.getTopStructElement()	Getter for the field topStructElement.

Methods in io.goobi.viewer.model.viewer that return types with arguments of type StructElement

Modifier and Type	Method	Description
List<StructElement>	PhysicalElement.getContainedStructElements()	List of struct elements that start on this page.

Methods in io.goobi.viewer.model.viewer with parameters of type StructElement

Modifier and Type	Method	Description
String	ViewManager.getDocumentTitle(StructElement document)	getDocumentTitle.
void	ViewManager.setCurrentStructElement(StructElement currentStructElement)	Setter for the field currentStructElement.
void	StructElement.setTopStruct(StructElement topStruct)
void	ViewManager.setTopStructElement(StructElement topStructElement)	setTopStructElement.

Constructors in io.goobi.viewer.model.viewer with parameters of type StructElement

Modifier	Constructor	Description
	ViewManager(StructElement topDocument, IPageLoader pageLoader, long currentDocumentIddoc, String logId, String mimeType, ImageDeliveryBean imageDeliveryBean)	Constructor for ViewManager.

Uses of StructElement in io.goobi.viewer.model.viewer.pageloader

Methods in io.goobi.viewer.model.viewer.pageloader with parameters of type StructElement

Modifier and Type	Method	Description
static AbstractPageLoader	AbstractPageLoader.create(StructElement topStructElement)	Creates and returns the appropriate loader instance for the given StructElement.
static AbstractPageLoader	AbstractPageLoader.create(StructElement topStructElement, boolean loadPages)	Creates and returns the appropriate loader instance for the given StructElement.
static AbstractPageLoader	AbstractPageLoader.create(StructElement topStructElement, List<Integer> pageNosToLoad)
static PhysicalElement	AbstractPageLoader.loadPage(StructElement topElement, int page)	loadPage.
protected static PhysicalElement	AbstractPageLoader.loadPageFromDoc(org.apache.solr.common.SolrDocument doc, String pi, StructElement topElement, Map<Integer,Long> pageOwnerIddocMap)	loadPageFromDoc.

Uses of StructElement in io.goobi.viewer.servlets.oembed

Methods in io.goobi.viewer.servlets.oembed that return StructElement

Modifier and Type	Method	Description
StructElement	OEmbedRecord.getStructElement()	Getter for the field structElement.

Methods in io.goobi.viewer.servlets.oembed with parameters of type StructElement

Modifier and Type	Method	Description
void	OEmbedRecord.setStructElement(StructElement structElement)	Setter for the field structElement.

Uses of StructElement in io.goobi.viewer.solr

Methods in io.goobi.viewer.solr with parameters of type StructElement

Modifier and Type	Method	Description
static List<Locale>	SolrTools.getAllUsedLocales(StructElement structElement)
static Map<String,List<String>>	SolrTools.getMetadataValuesForLanguage(StructElement doc, String key)	getMetadataValuesForLanguage.
PhysicalElement	SolrSearchIndex.getPage(StructElement struct, int order)	getPage.
static Optional<de.intranda.metadata.multilanguage.IMetadataValue>	SolrTools.getTranslations(String fieldName, StructElement doc, BinaryOperator<String> combiner)	getTranslations.
static Optional<de.intranda.metadata.multilanguage.IMetadataValue>	SolrTools.getTranslations(String fieldName, StructElement doc, List<Locale> translationLocales, BinaryOperator<String> combiner)	getTranslations.