com.ibm.ecm.extension

Class PluginDocumentContent

  1. java.lang.Object
  2. extended bycom.ibm.ecm.extension.PluginDocumentContent
  1. public abstract class PluginDocumentContent
  2. extends java.lang.Object
Instances of PluginDocumentContent are returned by some of the PluginServicesCallbacks.retrieveDocumentContent to provide access to document content.

Field Summary

Modifier and Type Field and Description
  1. protected
  2. java.lang.String
 name
  1. protected
  2. java.util.List<java.lang.String>
 partContentType
  1. protected
  2. long
 size
  1. protected
  2. java.lang.String
 type

Constructor Summary

Constructor and Description
PluginDocumentContent()

Method Summary

Modifier and Type Method and Description
  1. int
 getContentPartCount()
CM - returns the number of parts in the document.
  1. long
 getContentSize()
Returns the content size, if known.
  1. java.lang.String
 getContentType()
Returns the mimetype of the document(/part;/element)
  1. java.lang.String
 getContentUrl()
P8 - returns the url for external document/elements, otherwise returns null.
  1. java.lang.String
 getFileName()
Get the file name for the document(/part;/element)
  1. abstract
  2. java.io.InputStream
 getInputStream()
Returns the InputStream of the document(/part;/element) content stream.
  1. int
 getNumPagesInLastSegment()
OD - returns the number of pages in the last segment.
  1. int
 getNumPagesInSegment()
OD - returns the number of pages per segment.
  1. int
 getNumSegments()
OD - returns the number of segments in the document.
  1. java.lang.String
 getPartContentType(int partNum)
CM - Returns the mimetype of the part, for multi-part documents.
  1. java.lang.String
 getTextEncoding()
CM - returns the encoding for text/plain documents For other repositories, returns null.
  1. boolean
 isViaUrl()
P8 - returns true for external document/elements.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

  1. protected java.lang.String type

size

  1. protected long size

name

  1. protected java.lang.String name

partContentType

  1. protected java.util.List<java.lang.String> partContentType

Constructor Detail

PluginDocumentContent

  1. public PluginDocumentContent()

Method Detail

getFileName

  1. public java.lang.String getFileName( )
Get the file name for the document(/part;/element)
Returns:

getContentType

  1. public java.lang.String getContentType( )
Returns the mimetype of the document(/part;/element)
Returns:

getPartContentType

  1. public java.lang.String getPartContentType( int partNum)
CM - Returns the mimetype of the part, for multi-part documents. P8 - Returns the mimetype of the part for multi-part documents. For other repositories, returns the same value as getContentType, for partNum value of 1, otherwise returns null.
Parameters:
partNum -
Returns:
Since:
2.0.3

getContentSize

  1. public long getContentSize()
Returns the content size, if known. If unknown, returns 0.
Returns:

getInputStream

  1. public abstract java.io.InputStream getInputStream( )
  2. throws java.lang.Exception
Returns the InputStream of the document(/part;/element) content stream.
Returns:
Throws:
java.lang.Exception

isViaUrl

  1. public boolean isViaUrl()
P8 - returns true for external document/elements. For other repositories returns false.
Returns:

getContentUrl

  1. public java.lang.String getContentUrl( )
P8 - returns the url for external document/elements, otherwise returns null. For other repositories returns false.
Returns:

getContentPartCount

  1. public int getContentPartCount( )
CM - returns the number of parts in the document. P8 - returns the number of content elements in the document. For other repositories, returns 1.
Returns:
int

getTextEncoding

  1. public java.lang.String getTextEncoding( )
CM - returns the encoding for text/plain documents For other repositories, returns null.
Returns:

getNumSegments

  1. public int getNumSegments()
OD - returns the number of segments in the document. For other repositories, returns -1.
Returns:

getNumPagesInSegment

  1. public int getNumPagesInSegment( )
OD - returns the number of pages per segment. For other repositories, returns -1.
Returns:

getNumPagesInLastSegment

  1. public int getNumPagesInLastSegment( )
OD - returns the number of pages in the last segment. For other repositories, returns -1.
Returns: