Package org.dlese.dpc.index.writer

Class WebLogWriter

java.lang.Object
org.dlese.dpc.index.writer.WebLogWriter
All Implemented Interfaces:
DocWriter
public class WebLogWriter extends Object implements DocWriter
Writes a Lucene Document that holds information about a client request to an HTTP servlet.
The Lucene Document fields that are created by this class are:

requestdate - The date of the client request. Stored.
requesturl - The URL and query the client requested. Stored.
remotehost - The requesting client's host name or IP address. Stored.
notes - Free text notes related to this log entry. Stored.
doctype - The document format type, which is 'weblog,' with '0' appended to support wildcard searching.
readerclass - The class which is used to read Documents created by this writer, which is 'WebLogReader'.
admindefaultfield - The default field that holds all content for searching. 'WebLogReader'.

Author:
John Weatherley
See Also:

  • Constructor Details

    • WebLogWriter

      public WebLogWriter()
      Constructor for the WebLogWriter object

  • Method Details

    • getDocType

      public String getDocType()
      Gets doctype, which is "weblog".
      Specified by:
      getDocType in interface DocWriter
      Returns:
      The String "weblog".

    • getReaderClass

      public String getReaderClass()
      Gets the name of the concrete DocReader class that is used to read this type of Document, which is "WebLogReader".
      Specified by:
      getReaderClass in interface DocWriter
      Returns:
      The String "WebLogReader".

    • log

      public final org.apache.lucene.document.Document log(HttpServletRequest request)
      Create a log entry Document.
      Parameters:
      request - The HTTP request.
      Returns:
      A Document for indexing the request.

    • log

      public final org.apache.lucene.document.Document log(HttpServletRequest request, String notes)
      Create a log entry Document, storing and indexing the given notes.
      Parameters:
      request - The HTTP request.
      notes - Notes about this web log entry.
      Returns:
      A Document for indexing the request.

    • addToAdminDefaultField

      protected final void addToAdminDefaultField(String value, StringBuffer adminDefaultBuffer)
      Adds the given String to a text field referenced in the index by the field name 'default'. The default field may be used in queries to quickly search for text across fields. This method should be called from the addCustomFields of implementing classes.
      Parameters:
      value - A text string to be added to the indexed field named 'default.'
      adminDefaultBuffer - The feature to be added to the ToDefaultField attribute