com.saperion.ngc.viewer

Class DocumentAnalyzer

java.lang.Object

com.saperion.ngc.viewer.DocumentAnalyzer

public final class DocumentAnalyzer
extends Object

Contains methods used to analyze a document or it's structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentAnalyzer.StructureInfos The Class StructureInfos contains information about a document's structure..

Method Summary

Methods

Modifier and Type	Method and Description
static DocumentAnalyzer.StructureInfos	externalGetStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure, int wantedElement, javax.servlet.http.HttpSession session) Gets information about a document's structure.
static DocumentAnalyzer.StructureInfos	externalGetStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure, int wantedElement, Set<String> supportedFormats, javax.servlet.http.HttpSession session) Gets information about a document's structure.
static DocumentAnalyzer.StructureInfos	getStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure, int wantedElement) Gets information about a document's structure.
static DocumentAnalyzer.StructureInfos	getStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure, int wantedElement, Set<String> supportedFormats) Gets information about a document's structure.

Methods inherited from class java.lang.Object

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

Method Detail

externalGetStructureInfos

public static DocumentAnalyzer.StructureInfos externalGetStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure,
                                                        int wantedElement,
                                                        javax.servlet.http.HttpSession session)

Gets information about a document's structure. Same as getStructureInfos, but can be used by servlets or JSPs. This method ignores the supported formats of the viewer.

Parameters:

structure - the elements of the structure

wantedElement - A special element of the document structure.

session - the current session

Returns:

the structure information

externalGetStructureInfos

public static DocumentAnalyzer.StructureInfos externalGetStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure,
                                                        int wantedElement,
                                                        Set<String> supportedFormats,
                                                        javax.servlet.http.HttpSession session)

Gets information about a document's structure. Same as getStructureInfos, but can be used by servlets or JSPs.

Parameters:

structure - the elements of the structure

wantedElement - A special element of the document structure.

supportedFormats - set of supported formats by filename extension (in upper-case)

session - the current session

Returns:

the structure information

getStructureInfos

public static DocumentAnalyzer.StructureInfos getStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure,
                                                int wantedElement)

Gets information about a document's structure. This method ignores the supported formats of the viewer.

Parameters:

structure - the elements of the structure

wantedElement - A special element of the document structure.

Returns:

the structure information

getStructureInfos

public static DocumentAnalyzer.StructureInfos getStructureInfos(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> structure,
                                                int wantedElement,
                                                Set<String> supportedFormats)

Gets information about a document's structure.

Parameters:

structure - the elements of the structure

wantedElement - A special element of the document structure.

supportedFormats - set of supported formats by filename extension (in upper-case)

Returns:

the structure information