org.silverpeas.viewer.web
Class DocumentViewEntity

java.lang.Object
  org.silverpeas.viewer.web.AbstractPreviewEntity<DocumentViewEntity>
      org.silverpeas.viewer.web.DocumentViewEntity

All Implemented Interfaces:

Exposable, Serializable

public class DocumentViewEntity
extends AbstractPreviewEntity<DocumentViewEntity>

The document view entity is a document view instance that is exposed in the web as an entity (web entity).

Author:

Yohann Chastagnier

See Also:

Serialized Form

Constructor Summary

protected	DocumentViewEntity()
protected	DocumentViewEntity(DocumentView documentView, String language) Default constructor

Method Summary

static DocumentViewEntity	createFrom(DocumentView documentView, String language) Creates a new document view entity from the specified document view.
protected String	getDisplayLicenseKey()
protected String	getDisplayViewerPath()
protected boolean	getDocumentSplit()
protected String	getHeight()
protected String	getLanguage()
protected int	getNbPages()
protected String	getOriginalFileName()
protected boolean	getSearchDataComputed()
protected String	getUrl()
protected String	getWidth()

Methods inherited from class org.silverpeas.viewer.web.AbstractPreviewEntity

getURI, withURI

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentViewEntity

protected DocumentViewEntity(DocumentView documentView,
                             String language)

Default constructor

Parameters:

documentView -

language -

DocumentViewEntity

protected DocumentViewEntity()

Method Detail

createFrom

public static DocumentViewEntity createFrom(DocumentView documentView,
                                            String language)

Creates a new document view entity from the specified document view.

Parameters:

documentView -

language -

Returns:

the entity representing the specified document view.

getDisplayLicenseKey

protected String getDisplayLicenseKey()

Returns:

the displayLicenseKey

getDisplayViewerPath

protected String getDisplayViewerPath()

Returns:

the displayViewerPath

getUrl

protected String getUrl()

Returns:

the urlBase

getOriginalFileName

protected String getOriginalFileName()

Returns:

the originalFileName

getWidth

protected String getWidth()

Returns:

the width

getHeight

protected String getHeight()

Returns:

the height

getLanguage

protected String getLanguage()

Returns:

the language

getNbPages

protected int getNbPages()

Returns:

the nbPages

getDocumentSplit

protected boolean getDocumentSplit()

Returns:

the documentSplit

getSearchDataComputed

protected boolean getSearchDataComputed()

Returns:

the searchDataComputed