Package com.saperion.ngc.model.document

Class ClassicConnectorPageArchiveMetaInfo

java.lang.Object

com.saperion.ngc.model.document.ClassicConnectorPageArchiveMetaInfo

All Implemented Interfaces:

DocumentArchiveMetaInfo.ElementArchiveMetaInfo, Serializable

public class ClassicConnectorPageArchiveMetaInfo
extends Object
implements DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Holds the meta information about a page of a document that is stored in the archive and obtained by the classic connector. Actually wraps SaDocInfo.ElementInfo

Author:

jsc

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.saperion.ngc.model.document.intf.DocumentArchiveMetaInfo.ElementArchiveMetaInfo

MULTIPAGE_TIFF_INDICATOR

Constructor Summary

Constructors

Constructor	Description
ClassicConnectorPageArchiveMetaInfo(com.saperion.intf.SaDocInfo.ElementInfo info, String parentDocUid)	constructor.

Method Summary

Modifier and Type	Method	Description
String	getDocUid()
int	getFrameCount()
String	getFullName()	Returns the full name of the element as it was stored in the archive (with page-numbers for multi-page-tiffs but without path).
String	getLinkUid()
String	getName()	Returns only the name of the element.
int	getNumber()
int	getPageCount()
long	getSize()
String	getStructureDocUid()
int	getStructureLevel()
com.saperion.intf.SaDocInfo.ElementType	getType()
Properties	getVariableData()
boolean	isMergedMultipageDocument()	Returns true if this element is a multipage document (TIFF or scanned pages) which was merged to one document by the core server.
boolean	isMultipageTiff()	Multipage tiff files contain @<page#> in full-name.
boolean	isSelected()
boolean	isVisible()	Checks if this element should be visible in structure-views or not.

Methods inherited from class java.lang.Object

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

Constructor Details

ClassicConnectorPageArchiveMetaInfo

public ClassicConnectorPageArchiveMetaInfo(com.saperion.intf.SaDocInfo.ElementInfo info,
 String parentDocUid)

constructor.

Parameters:

info - The wrapped Elementinfo

Method Details

getNumber

public int getNumber()

Specified by:

getNumber in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

Number of element

getFullName

public String getFullName()

Returns the full name of the element as it was stored in the archive (with page-numbers for multi-page-tiffs but without path).

Specified by:

getFullName in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

full name of the element

getName

public String getName()

Returns only the name of the element. For multi-page tiffs, the page number will be removed.

Specified by:

getName in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

Element name

getType

public com.saperion.intf.SaDocInfo.ElementType getType()

Specified by:

getType in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

Element type

isSelected

public boolean isSelected()

Specified by:

isSelected in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

True, if selected

getVariableData

public Properties getVariableData()

Specified by:

getVariableData in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

element variable data

getSize

public long getSize()

Specified by:

getSize in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

element's size

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

the number of pages (for files with several pages)

getFrameCount

public int getFrameCount()

Specified by:

getFrameCount in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

the number of frames

getDocUid

public String getDocUid()

Specified by:

getDocUid in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

the uid of the page

getLinkUid

public String getLinkUid()

Specified by:

getLinkUid in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

the uid of the linked document if the page is a link.

getStructureDocUid

public String getStructureDocUid()

Specified by:

getStructureDocUid in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

the uid of structure which contains the document / page

getStructureLevel

public int getStructureLevel()

Specified by:

getStructureLevel in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

the element's level in the structure hierarchy. 0 indicates unstructured document..

isMultipageTiff

public boolean isMultipageTiff()

Description copied from interface: DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Multipage tiff files contain @<page#> in full-name.

Specified by:

isMultipageTiff in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

True if the Element is a multipage tiff. False else.

isMergedMultipageDocument

public boolean isMergedMultipageDocument()

Description copied from interface: DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns true if this element is a multipage document (TIFF or scanned pages) which was merged to one document by the core server.

Specified by:

isMergedMultipageDocument in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Returns:

true if merged document

isVisible

public boolean isVisible()

Description copied from interface: DocumentArchiveMetaInfo.ElementArchiveMetaInfo

Checks if this element should be visible in structure-views or not. Note: Currently, this is only used by the SAP-Viewer to hide sapfile.txt files.

Specified by:

isVisible in interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo