org.apache.jackrabbit.webdav.jcr.version.report
Class ExportViewReport

java.lang.Object
  extended byorg.apache.jackrabbit.webdav.jcr.version.report.ExportViewReport
All Implemented Interfaces:
org.apache.jackrabbit.webdav.version.report.Report

public class ExportViewReport
extends Object
implements org.apache.jackrabbit.webdav.version.report.Report

ExportViewReport handles REPORT requests for the 'exportview' report. The 'exportview' report is used to export DocView and SysView of the item represented by the requested resource.

The request body must contain a dcr:exportview element:

 <!ELEMENT exportview  ( (sysview | docview)?, skipbinary?, norecurse ) >
 <!ELEMENT sysview EMPTY >
 <!ELEMENT docview EMPTY >
 <!ELEMENT skipbinary EMPTY >
 <!ELEMENT norecurse EMPTY >
 
If no view type is specified the DocView is generated.


Field Summary
static org.apache.jackrabbit.webdav.version.report.ReportType EXPORTVIEW_REPORT
          The exportview report type
 
Constructor Summary
ExportViewReport()
           
 
Method Summary
 org.apache.jackrabbit.webdav.version.report.ReportType getType()
          Returns EXPORTVIEW_REPORT report type.
 void setInfo(org.apache.jackrabbit.webdav.version.report.ReportInfo info)
           
 void setResource(org.apache.jackrabbit.webdav.version.DeltaVResource resource)
           
 org.jdom.Document toXml()
          Creates a Xml document from the generated view.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXPORTVIEW_REPORT

public static final org.apache.jackrabbit.webdav.version.report.ReportType EXPORTVIEW_REPORT
The exportview report type

Constructor Detail

ExportViewReport

public ExportViewReport()
Method Detail

getType

public org.apache.jackrabbit.webdav.version.report.ReportType getType()
Returns EXPORTVIEW_REPORT report type.

Specified by:
getType in interface org.apache.jackrabbit.webdav.version.report.Report
Returns:
EXPORTVIEW_REPORT
See Also:
Report.getType()

setResource

public void setResource(org.apache.jackrabbit.webdav.version.DeltaVResource resource)
Specified by:
setResource in interface org.apache.jackrabbit.webdav.version.report.Report
Parameters:
resource - The resource this report is generated from. NOTE: the resource path of the resource is used as 'absPath' argument for exporting the specified view.
Throws:
IllegalArgumentException - if the resource is null or if the session object provided with the resource is null.
See Also:
Report.setResource(org.apache.jackrabbit.webdav.version.DeltaVResource)

setInfo

public void setInfo(org.apache.jackrabbit.webdav.version.report.ReportInfo info)
Specified by:
setInfo in interface org.apache.jackrabbit.webdav.version.report.Report
Parameters:
info -
Throws:
IllegalArgumentException - if the specified info object does not contain a dcr:exportview element.
See Also:
Report.setInfo(org.apache.jackrabbit.webdav.version.report.ReportInfo)

toXml

public org.jdom.Document toXml()
                        throws org.apache.jackrabbit.webdav.DavException
Creates a Xml document from the generated view.

Specified by:
toXml in interface org.apache.jackrabbit.webdav.version.report.Report
Returns:
Xml document representing the output of the specified view.
Throws:
org.apache.jackrabbit.webdav.DavException - if the report document could not be created.
See Also:
Report.toXml()


Copyright © 2005 . All Rights Reserved.