Package com.saperion.rmi

Class SaDocInfoImpl

java.lang.Object

com.saperion.rmi.SaDocInfoImpl

All Implemented Interfaces:

SaDocInfo, java.io.Serializable

public class SaDocInfoImpl
extends java.lang.Object
implements SaDocInfo

Implementation of the SaDocInfo interface.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.saperion.intf.SaDocInfo

SaDocInfo.ElementInfo, SaDocInfo.ElementType

Constructor Summary

Constructors

Constructor	Description
SaDocInfoImpl(int createUser)	Constructor.
SaDocInfoImpl(com.saperion.jna.applsrv.m2j.natives.DocumentInfoObject documentInfo, java.lang.String revisionId)	Constructor for JNA.
SaDocInfoImpl(java.util.Map<java.lang.Integer,SaDocInfo.ElementInfo> elements, int creator, java.lang.String hDoc, java.util.Properties variables)

Method Summary

Modifier and Type	Method	Description
void	addElementInfo(java.lang.String fName, int nr, byte elementType, boolean isSelected, java.util.Properties variableData, long dataSize, int pageCnt, int frameCnt, java.lang.String documentUid, java.lang.String lnkUid, int level)	Adds a new element info to the list.
void	addVariableData(java.lang.String name, java.lang.String value)	Adds new variable data record.
int	getCreateUser()
int	getElementCount()
java.util.List<SaDocInfo.ElementInfo>	getElementInfo()	Returns a list of the structure-elements of this document.
SaDocInfo.ElementInfo	getElementInfo(int elementNumber)	Returns the element info of the element with the specified number, if existing.
java.util.Map<java.lang.Integer,SaDocInfo.ElementInfo>	getElementInfoMap()	Returns the structure-elements as a map with the corresponding element number as key.
java.lang.String	getHdoc()
java.util.Properties	getVariableData()	Returns variables of the document.
boolean	hasAnnotations()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SaDocInfoImpl

public SaDocInfoImpl(java.util.Map<java.lang.Integer,SaDocInfo.ElementInfo> elements,
                     int creator,
                     java.lang.String hDoc,
                     java.util.Properties variables)

SaDocInfoImpl

public SaDocInfoImpl(int createUser)

Constructor.

Parameters:

createUser - Create user

SaDocInfoImpl

public SaDocInfoImpl(com.saperion.jna.applsrv.m2j.natives.DocumentInfoObject documentInfo,
                     java.lang.String revisionId)

Constructor for JNA.

Parameters:

documentInfo - native document info object

revisionId - hex-string of revision ID

Method Detail

addElementInfo

public void addElementInfo(java.lang.String fName,
                           int nr,
                           byte elementType,
                           boolean isSelected,
                           java.util.Properties variableData,
                           long dataSize,
                           int pageCnt,
                           int frameCnt,
                           java.lang.String documentUid,
                           java.lang.String lnkUid,
                           int level)

Adds a new element info to the list.

Parameters:

fName - File name

nr - Number

elementType - Element type

isSelected - Is selected

variableData - Properties object containing names and values of variables

dataSize - size of element

pageCnt - number of pages

frameCnt - number of frames

documentUid - uid of the document

lnkUid - uid of the linked document

level - element's level in the structure hierarchy

addVariableData

public void addVariableData(java.lang.String name,
                            java.lang.String value)

Adds new variable data record.

Parameters:

name - Name

value - Value

getCreateUser

public int getCreateUser()

Specified by:

getCreateUser in interface SaDocInfo

Returns:

Document create user

See Also:

SaDocInfo.getCreateUser()

getElementCount

public int getElementCount()

Specified by:

getElementCount in interface SaDocInfo

Returns:

Element count

See Also:

SaDocInfo.getElementCount()

getElementInfo

public java.util.List<SaDocInfo.ElementInfo> getElementInfo()

Returns a list of the structure-elements of this document.

Specified by:

getElementInfo in interface SaDocInfo

Returns:

Element information

See Also:

SaDocInfo.getElementInfo()

getElementInfoMap

public java.util.Map<java.lang.Integer,SaDocInfo.ElementInfo> getElementInfoMap()

Returns the structure-elements as a map with the corresponding element number as key.

Specified by:

getElementInfoMap in interface SaDocInfo

Returns:

the element information as a map.

See Also:

SaDocInfo.getElementInfoMap()

getElementInfo

public SaDocInfo.ElementInfo getElementInfo(int elementNumber)

Returns the element info of the element with the specified number, if existing. Null is returned if no element-info is existing for the given element number.

Specified by:

getElementInfo in interface SaDocInfo

Parameters:

elementNumber - The element number to get information for

Returns:

the document info for the given element number, if existing - null otherwise.

See Also:

SaDocInfo.getElementInfo(int elementNumber)

getVariableData

public java.util.Properties getVariableData()

Returns variables of the document. Use SaDocInfo.ElementInfo.getVariableData() to get variables contained in a specific element.

Specified by:

getVariableData in interface SaDocInfo

Returns:

Document variable data

See Also:

SaDocInfo.getVariableData()

hasAnnotations

public boolean hasAnnotations()

Specified by:

hasAnnotations in interface SaDocInfo

Returns:

true if the document contains annotations

See Also:

SaDocInfo.hasAnnotations()

getHdoc

public java.lang.String getHdoc()

Specified by:

getHdoc in interface SaDocInfo

Returns:

hDoc of the revision represented by this SaDocInfo instance

See Also:

SaDocInfo.getHdoc()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object