de.fh_mannheim.mm.dms.webengine
Class SearchReport

java.lang.Object
  extended byde.fh_mannheim.mm.dms.webengine.SearchReport
All Implemented Interfaces:
IReport

public class SearchReport
extends java.lang.Object
implements IReport

Discribes a report for data extraction.

Version:
$Revision: 1.6 $
Author:
Jan Löffler, mail@jlsoft.de

Field Summary
static int SHOW_OWN_SCHEDULED_UPLOADS
           
static int SHOW_OWN_UPLOADS
           
static int SHOW_SCHEDULED_UPLOADS
           
static int SHOW_UPLOADS
           
static int SITE_HELP
           
static int SITE_SEARCH
          Sites
static int SITE_UPLOAD
           
static int UNKNOWN
          Public declarations
 
Constructor Summary
SearchReport()
          Constructor.
 
Method Summary
 org.w3c.dom.Element getBookmarksElement(User user, org.w3c.dom.Document doc)
          Search bookmarks.
 org.w3c.dom.Element getCategoriesElement(User user, org.w3c.dom.Document doc)
          Search categories.
 org.w3c.dom.Element getCategoryElement(Category cat, int nUserID, org.w3c.dom.Document doc)
          Search category.
 org.w3c.dom.Element getCategoryElement(Category cat, int nLimit, int nUserID, org.w3c.dom.Document doc)
          Search category.
 org.w3c.dom.Element getFiletypeElement(org.w3c.dom.Document doc, int nFiletype)
          Generate filetype element.
 org.w3c.dom.Element getLanguageElement(org.w3c.dom.Document doc, int nLanguage)
          Generate language element.
 org.w3c.dom.Element getLoginElement(org.w3c.dom.Document doc, java.lang.String strMessage)
          Generate the login report.
 org.w3c.dom.Element getMessageElement(org.w3c.dom.Document doc, java.lang.String strMessage)
          Generate status message element.
 org.w3c.dom.Element getSearchElement(RequestParser request, org.w3c.dom.Document doc)
          Generate the search report.
 org.w3c.dom.Element getSearchFilesElement(java.lang.String strTitle, Query query, org.w3c.dom.Document doc)
          Search documents with given pattern.
 org.w3c.dom.Element getUploadElement(Upload upload, org.w3c.dom.Document doc)
          Return upload element.
 org.w3c.dom.Element getUploadListElement(org.w3c.dom.Document doc, int nType)
          Generate the upload report.
 org.w3c.dom.Element getUploadsElement(RequestParser request, org.w3c.dom.Document doc)
          Generate the upload report.
 User loginUser(javax.servlet.http.HttpServletRequest request)
          Login current user.
 org.w3c.dom.Document produceReport(javax.servlet.http.HttpServletRequest request)
          Generate the report as xml document.
 org.w3c.dom.Element uploadRequest(javax.servlet.http.HttpServletRequest request, org.w3c.dom.Document doc)
          Prepare a reqest.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNKNOWN

public static final int UNKNOWN
Public declarations

See Also:
Constant Field Values

SHOW_SCHEDULED_UPLOADS

public static final int SHOW_SCHEDULED_UPLOADS
See Also:
Constant Field Values

SHOW_OWN_SCHEDULED_UPLOADS

public static final int SHOW_OWN_SCHEDULED_UPLOADS
See Also:
Constant Field Values

SHOW_UPLOADS

public static final int SHOW_UPLOADS
See Also:
Constant Field Values

SHOW_OWN_UPLOADS

public static final int SHOW_OWN_UPLOADS
See Also:
Constant Field Values

SITE_SEARCH

public static final int SITE_SEARCH
Sites

See Also:
Constant Field Values

SITE_UPLOAD

public static final int SITE_UPLOAD
See Also:
Constant Field Values

SITE_HELP

public static final int SITE_HELP
See Also:
Constant Field Values
Constructor Detail

SearchReport

public SearchReport()
Constructor.

Method Detail

loginUser

public User loginUser(javax.servlet.http.HttpServletRequest request)
Login current user.

Parameters:
request - The servlet request we are processing
Returns:
current user

produceReport

public org.w3c.dom.Document produceReport(javax.servlet.http.HttpServletRequest request)
                                   throws java.lang.Exception
Generate the report as xml document.

Specified by:
produceReport in interface IReport
Parameters:
request - The current ServletRequest
Returns:
xml element
Throws:
java.lang.Exception

getUploadListElement

public org.w3c.dom.Element getUploadListElement(org.w3c.dom.Document doc,
                                                int nType)
                                         throws java.lang.Exception
Generate the upload report.

Parameters:
doc - Document for xml
nType - Type of uploadrequest
Returns:
xml element
Throws:
java.lang.Exception

getUploadsElement

public org.w3c.dom.Element getUploadsElement(RequestParser request,
                                             org.w3c.dom.Document doc)
                                      throws java.lang.Exception
Generate the upload report.

Parameters:
request -
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getSearchElement

public org.w3c.dom.Element getSearchElement(RequestParser request,
                                            org.w3c.dom.Document doc)
                                     throws java.lang.Exception
Generate the search report.

Parameters:
request -
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getFiletypeElement

public org.w3c.dom.Element getFiletypeElement(org.w3c.dom.Document doc,
                                              int nFiletype)
                                       throws java.lang.Exception
Generate filetype element.

Parameters:
doc - Document for xml
nFiletype - Filetype
Returns:
xml element
Throws:
java.lang.Exception

getLanguageElement

public org.w3c.dom.Element getLanguageElement(org.w3c.dom.Document doc,
                                              int nLanguage)
                                       throws java.lang.Exception
Generate language element.

Parameters:
doc - Document for xml
nLanguage - Language
Returns:
xml element
Throws:
java.lang.Exception

getLoginElement

public org.w3c.dom.Element getLoginElement(org.w3c.dom.Document doc,
                                           java.lang.String strMessage)
                                    throws java.lang.Exception
Generate the login report.

Parameters:
doc - Document for xml
strMessage - Messagetext
Returns:
xml element
Throws:
java.lang.Exception

getMessageElement

public org.w3c.dom.Element getMessageElement(org.w3c.dom.Document doc,
                                             java.lang.String strMessage)
Generate status message element.

Parameters:
doc - Document for xml
strMessage - Messagetext
Returns:
xml element
Throws:
java.lang.Exception

uploadRequest

public org.w3c.dom.Element uploadRequest(javax.servlet.http.HttpServletRequest request,
                                         org.w3c.dom.Document doc)
                                  throws java.lang.Exception
Prepare a reqest.

Parameters:
request - Request with filestream
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getSearchFilesElement

public org.w3c.dom.Element getSearchFilesElement(java.lang.String strTitle,
                                                 Query query,
                                                 org.w3c.dom.Document doc)
                                          throws java.lang.Exception
Search documents with given pattern.

Parameters:
strTitle - Title
query - Query
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getBookmarksElement

public org.w3c.dom.Element getBookmarksElement(User user,
                                               org.w3c.dom.Document doc)
                                        throws java.lang.Exception
Search bookmarks.

Parameters:
user - User
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getCategoriesElement

public org.w3c.dom.Element getCategoriesElement(User user,
                                                org.w3c.dom.Document doc)
                                         throws java.lang.Exception
Search categories.

Parameters:
user - User
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getCategoryElement

public org.w3c.dom.Element getCategoryElement(Category cat,
                                              int nUserID,
                                              org.w3c.dom.Document doc)
                                       throws java.lang.Exception
Search category.

Parameters:
cat - Category
nUserID - ID of user
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getCategoryElement

public org.w3c.dom.Element getCategoryElement(Category cat,
                                              int nLimit,
                                              int nUserID,
                                              org.w3c.dom.Document doc)
                                       throws java.lang.Exception
Search category.

Parameters:
cat - Category
nLimit - Limit
nUserID - ID of user
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception

getUploadElement

public org.w3c.dom.Element getUploadElement(Upload upload,
                                            org.w3c.dom.Document doc)
                                     throws java.lang.Exception
Return upload element.

Parameters:
upload - Upload
doc - Document for xml
Returns:
xml element
Throws:
java.lang.Exception