com.dfki.peregrin.servlet
Class SiteServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--com.dfki.peregrin.servlet.SiteServlet
All Implemented Interfaces:
java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SiteServlet
extends javax.servlet.http.HttpServlet

Basis class for accessing the XML data. It redefines the methods doGet, doPost and init inherited from the HttpServlet class.

Version:
early
Author:
Markus Perling
See Also:
HttpServlet, Serialized Form

Field Summary
 java.lang.String absGlobalPath
          Contains the name of the variable whose value is the absolute global path.
 java.lang.String globalPath
          Contains the name of the variable whose value is the global path.
 java.lang.String templatePath
          Contains the name of the variable whose value is the path to the template currently applied.
 java.lang.String This
          Contains the name of the variable whose value is the path to the current position.
 
Constructor Summary
SiteServlet()
          Initializes the hashtable of globally known strings.
 
Method Summary
 void addConceptAttribute(java.lang.String name)
           
 void addFlVariable(java.lang.String name)
           
 void addServletAction(java.lang.String name)
           
 void addStaticVariable(java.lang.String name, java.lang.String value)
           
 java.lang.String aID()
           
 java.lang.String bID()
           
 void block()
           
 void block(java.lang.String cp)
           
 java.lang.String bodyID()
           
 java.lang.String conceptAttribute(java.lang.String name)
           
 StringKeyTable conceptAttributes()
           
 java.lang.String configServletPath()
           
 java.lang.String contentID()
           
 SiteNode defaultTemplate()
           
 int depth()
           
 void doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Overrides the javax.servlet.http.HttpServlet.doGet method.
 void doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Overrides the javax.servlet.http.HttpServlet.doPost method.
 java.lang.String evaluateID()
           
 java.lang.String existsID()
           
 java.lang.String flVariable(java.lang.String name)
           
 StringKeyTable flVariables()
           
 java.lang.String fullServletPath()
           
 java.lang.Integer getFileCounter()
           
 java.lang.String h1ID()
           
 java.lang.String h2ID()
           
 java.lang.String h3ID()
           
 java.lang.String h4ID()
           
 java.lang.String homeID()
           
 java.net.URL host()
          returns the URL of the host machine
 java.lang.String hostWithPort()
           
 java.lang.String htmlID()
           
 java.lang.String iID()
           
 java.lang.String imgID()
           
 void init(javax.servlet.ServletConfig config)
          Initializes servlet.
 boolean isBlocked()
           
 boolean isSensitiveID(java.lang.String s)
           
 java.lang.String leftID()
           
 java.lang.String linkID()
           
 void log(java.lang.String s)
           
 java.io.File logFile()
           
 int maxTags()
           
 java.lang.String mergeID()
           
 StringKeyTable nodeNames()
           
 java.lang.String nosearchID()
           
 java.lang.String partialServletPath()
           
 java.lang.String pathID()
           
 java.lang.String port()
           
 int portNumber()
           
 java.lang.String provideID()
           
 java.lang.String requestID()
           
 void resetStatus()
           
 java.lang.String rightID()
           
 java.net.URL schema()
           
 java.lang.String searchFailTemplatePath()
           
 java.lang.String searchformID()
           
 java.lang.String searchinputID()
           
 java.lang.String searchregisterID()
           
 java.lang.String searchResultID()
           
 java.lang.String searchResultItemTemplatePath()
           
 java.lang.String searchResultNumberID()
           
 java.lang.String searchResultTemplatePath()
           
 java.lang.String searchselectID()
           
 java.lang.String servletAction(java.lang.String name)
           
 VariableTable servletActions()
           
 javax.servlet.ServletConfig servletConfig()
           
 java.lang.String servletPath()
           
 void setDefaultTemplate(SiteNode template)
           
 void setDepth(int d)
           
 void setLogFile(java.io.File f)
          Creates log file
 void setMaxTags(int t)
           
 void setPort(java.lang.String p)
           
 void setPortNumber(int pn)
           
 void setSchema(java.net.URL u)
           
 void setSearchFailTemplatePath(java.lang.String s)
           
 void setSearchResultItemTemplatePath(java.lang.String s)
           
 void setSearchResultTemplatePath(java.lang.String s)
           
 void setServletConfig(javax.servlet.ServletConfig config)
           
 void setServletPath(java.lang.String s)
           
 void setStyleSheet(java.net.URL u)
           
 VariableTable staticVariables()
           
 java.lang.String storeID()
           
 java.net.URL styleSheet()
           
 java.lang.String ttID()
           
 void unblock()
           
 java.lang.String upID()
           
 java.lang.String valueOfStaticVariable(java.lang.String name)
           
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doOptions, doPut, doTrace, getLastModified, service, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, init, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

globalPath

public final java.lang.String globalPath
Contains the name of the variable whose value is the global path.

absGlobalPath

public final java.lang.String absGlobalPath
Contains the name of the variable whose value is the absolute global path.

This

public final java.lang.String This
Contains the name of the variable whose value is the path to the current position.

templatePath

public final java.lang.String templatePath
Contains the name of the variable whose value is the path to the template currently applied.
Constructor Detail

SiteServlet

public SiteServlet()
Initializes the hashtable of globally known strings.
Method Detail

init

public void init(javax.servlet.ServletConfig config)
Initializes servlet. First it gets the global preferences, then it invokes the XML parsing process.
Overrides:
init in class javax.servlet.GenericServlet
Parameters:
config - contains configuration parameters

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException
Overrides the javax.servlet.http.HttpServlet.doPost method.
Overrides:
doPost in class javax.servlet.http.HttpServlet
Parameters:
request - an HttpServletRequest object that contains the request the client has made of the servlet
response - an HttpServletResponse object that contains the response the servlet sends to the client
Throws:
javax.servlet.ServletException -  
java.io.IOException -  
See Also:
javax.servlet.http.HttpServlet.doPost

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  java.io.IOException
Overrides the javax.servlet.http.HttpServlet.doGet method.
Overrides:
doGet in class javax.servlet.http.HttpServlet
Parameters:
request - an HttpServletRequest object that contains the request the client has made of the servlet
response - an HttpServletResponse object that contains the response the servlet sends to the client
Throws:
javax.servlet.ServletException -  
java.io.IOException -  
See Also:
javax.servlet.http.HttpServlet.doGet

host

public java.net.URL host()
returns the URL of the host machine

port

public java.lang.String port()

setPort

public void setPort(java.lang.String p)

resetStatus

public void resetStatus()

block

public void block(java.lang.String cp)

block

public void block()

unblock

public void unblock()

isBlocked

public boolean isBlocked()

servletConfig

public javax.servlet.ServletConfig servletConfig()

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig config)

configServletPath

public java.lang.String configServletPath()

depth

public int depth()

setDepth

public void setDepth(int d)

portNumber

public int portNumber()

setPortNumber

public void setPortNumber(int pn)

hostWithPort

public java.lang.String hostWithPort()

fullServletPath

public java.lang.String fullServletPath()

partialServletPath

public java.lang.String partialServletPath()

maxTags

public int maxTags()

setMaxTags

public void setMaxTags(int t)

setStyleSheet

public void setStyleSheet(java.net.URL u)

styleSheet

public java.net.URL styleSheet()

setLogFile

public void setLogFile(java.io.File f)
Creates log file

logFile

public java.io.File logFile()

log

public void log(java.lang.String s)
Overrides:
log in class javax.servlet.GenericServlet

setSchema

public void setSchema(java.net.URL u)

schema

public java.net.URL schema()

setDefaultTemplate

public void setDefaultTemplate(SiteNode template)

defaultTemplate

public SiteNode defaultTemplate()

setSearchResultTemplatePath

public void setSearchResultTemplatePath(java.lang.String s)

searchResultTemplatePath

public java.lang.String searchResultTemplatePath()

setSearchResultItemTemplatePath

public void setSearchResultItemTemplatePath(java.lang.String s)

searchResultItemTemplatePath

public java.lang.String searchResultItemTemplatePath()

setSearchFailTemplatePath

public void setSearchFailTemplatePath(java.lang.String s)

searchFailTemplatePath

public java.lang.String searchFailTemplatePath()

addStaticVariable

public void addStaticVariable(java.lang.String name,
                              java.lang.String value)

valueOfStaticVariable

public java.lang.String valueOfStaticVariable(java.lang.String name)

staticVariables

public VariableTable staticVariables()

addServletAction

public void addServletAction(java.lang.String name)

servletAction

public java.lang.String servletAction(java.lang.String name)

servletActions

public VariableTable servletActions()

servletPath

public java.lang.String servletPath()

setServletPath

public void setServletPath(java.lang.String s)

getFileCounter

public java.lang.Integer getFileCounter()

nodeNames

public StringKeyTable nodeNames()

conceptAttributes

public StringKeyTable conceptAttributes()

addConceptAttribute

public void addConceptAttribute(java.lang.String name)

conceptAttribute

public java.lang.String conceptAttribute(java.lang.String name)

flVariables

public StringKeyTable flVariables()

addFlVariable

public void addFlVariable(java.lang.String name)

flVariable

public java.lang.String flVariable(java.lang.String name)

provideID

public java.lang.String provideID()

linkID

public java.lang.String linkID()

mergeID

public java.lang.String mergeID()

existsID

public java.lang.String existsID()

storeID

public java.lang.String storeID()

aID

public java.lang.String aID()

nosearchID

public java.lang.String nosearchID()

imgID

public java.lang.String imgID()

ttID

public java.lang.String ttID()

bID

public java.lang.String bID()

iID

public java.lang.String iID()

h1ID

public java.lang.String h1ID()

h2ID

public java.lang.String h2ID()

h3ID

public java.lang.String h3ID()

h4ID

public java.lang.String h4ID()

bodyID

public java.lang.String bodyID()

htmlID

public java.lang.String htmlID()

evaluateID

public java.lang.String evaluateID()

requestID

public java.lang.String requestID()

contentID

public java.lang.String contentID()

searchinputID

public java.lang.String searchinputID()

searchselectID

public java.lang.String searchselectID()

searchregisterID

public java.lang.String searchregisterID()

searchformID

public java.lang.String searchformID()

homeID

public java.lang.String homeID()

upID

public java.lang.String upID()

leftID

public java.lang.String leftID()

rightID

public java.lang.String rightID()

pathID

public java.lang.String pathID()

searchResultID

public java.lang.String searchResultID()

searchResultNumberID

public java.lang.String searchResultNumberID()

isSensitiveID

public boolean isSensitiveID(java.lang.String s)