org.outerj.daisy.publisher.serverimpl.requestmodel
Class RootPublisherContext

java.lang.Object
  extended by org.outerj.daisy.publisher.serverimpl.requestmodel.RootPublisherContext
All Implemented Interfaces:
PublisherContext

public class RootPublisherContext
extends java.lang.Object
implements PublisherContext


Field Summary
 
Fields inherited from interface org.outerj.daisy.publisher.serverimpl.requestmodel.PublisherContext
NO_VERSION
 
Constructor Summary
RootPublisherContext(org.outerj.daisy.repository.Repository repository, PublisherImpl publisher, org.apache.avalon.framework.logger.Logger logger)
           
 
Method Summary
 long getBranchId()
           
 ContentProcessor getContentProcessor()
          Returns null if not available.
 org.outerj.daisy.repository.Document getDocument()
           
 long getDocumentId()
           
 long getLanguageId()
           
 java.util.Locale getLocale()
           
 org.apache.avalon.framework.logger.Logger getLogger()
           
 PreparedDocuments getPreparedDocuments()
          Returns null if not available.
 PublisherImpl getPublisher()
           
 org.outerj.daisy.repository.Repository getRepository()
           
 java.text.DateFormat getTimestampFormat()
           
 org.outerj.daisy.repository.VariantKey getVariantKey()
           
 org.outerj.daisy.repository.Version getVersion()
          If a live version was requested but the document doesn't have a live version, this method returns null.
 long getVersionId()
          If a live version was requested but the document doesn't have a live version, this method returns NO_VERSION.
 PublisherVersionMode getVersionMode()
           
 boolean hasDocument()
          Returns true if the getDocument and getVersion methods can safely be called.
 boolean searchRecursivePrepDocs(long documentId, long branchId, long languageId, java.lang.String pubReqSetName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RootPublisherContext

public RootPublisherContext(org.outerj.daisy.repository.Repository repository,
                            PublisherImpl publisher,
                            org.apache.avalon.framework.logger.Logger logger)
Method Detail

getLocale

public java.util.Locale getLocale()
Specified by:
getLocale in interface PublisherContext

getRepository

public org.outerj.daisy.repository.Repository getRepository()
Specified by:
getRepository in interface PublisherContext

getTimestampFormat

public java.text.DateFormat getTimestampFormat()
Specified by:
getTimestampFormat in interface PublisherContext

getDocumentId

public long getDocumentId()
Specified by:
getDocumentId in interface PublisherContext

getBranchId

public long getBranchId()
Specified by:
getBranchId in interface PublisherContext

getLanguageId

public long getLanguageId()
Specified by:
getLanguageId in interface PublisherContext

getVariantKey

public org.outerj.daisy.repository.VariantKey getVariantKey()
Specified by:
getVariantKey in interface PublisherContext

getVersionId

public long getVersionId()
Description copied from interface: PublisherContext
If a live version was requested but the document doesn't have a live version, this method returns NO_VERSION. Otherwise, the actual version number is returned.

Specified by:
getVersionId in interface PublisherContext

getDocument

public org.outerj.daisy.repository.Document getDocument()
Specified by:
getDocument in interface PublisherContext

getVersion

public org.outerj.daisy.repository.Version getVersion()
                                               throws org.outerj.daisy.repository.RepositoryException
Description copied from interface: PublisherContext
If a live version was requested but the document doesn't have a live version, this method returns null.

Specified by:
getVersion in interface PublisherContext
Throws:
org.outerj.daisy.repository.RepositoryException

hasDocument

public boolean hasDocument()
Description copied from interface: PublisherContext
Returns true if the getDocument and getVersion methods can safely be called. (though getVersion might return null)

Specified by:
hasDocument in interface PublisherContext

getPublisher

public PublisherImpl getPublisher()
Specified by:
getPublisher in interface PublisherContext

getLogger

public org.apache.avalon.framework.logger.Logger getLogger()
Specified by:
getLogger in interface PublisherContext

getPreparedDocuments

public PreparedDocuments getPreparedDocuments()
Description copied from interface: PublisherContext
Returns null if not available.

Specified by:
getPreparedDocuments in interface PublisherContext

getContentProcessor

public ContentProcessor getContentProcessor()
Description copied from interface: PublisherContext
Returns null if not available.

Specified by:
getContentProcessor in interface PublisherContext

searchRecursivePrepDocs

public boolean searchRecursivePrepDocs(long documentId,
                                       long branchId,
                                       long languageId,
                                       java.lang.String pubReqSetName)
Specified by:
searchRecursivePrepDocs in interface PublisherContext

getVersionMode

public PublisherVersionMode getVersionMode()
Specified by:
getVersionMode in interface PublisherContext


Copyright © -2012 . All Rights Reserved.