|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.util.qos.QueryRefinementQos
public abstract class QueryRefinementQos
Base class till helper classes such as AccessFilterQos and QuerySpecQos.
<filter type='ContentLength' version='1.0'> 800 </filter>This example addresses the plugin in xmlBlaster.properties file
MimeAccessPlugin[ContentLenFilter][1.0]=org.xmlBlaster.engine.mime.demo.ContentLenFilterThe filter rules apply for cluster configuration as well.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_version
The version of the plugin |
protected Global |
glob
|
private static java.util.logging.Logger |
log
|
protected java.lang.String |
logName
the name to assign to the log of the extending class |
protected java.lang.String |
ME
|
protected Query |
query
The filter/query rule string and an object to hold the prepared query on demand |
protected java.lang.String |
tagName
the tag name specific to the extending class |
protected java.lang.String |
type
The plugin name e.g. |
private java.lang.String |
version
|
protected java.lang.String |
versionProp
the name of the property retrieving the version of the plugin of the extending class |
Constructor Summary | |
---|---|
protected |
QueryRefinementQos(Global glob,
java.lang.String type,
java.lang.String version,
Query query,
java.lang.String tagName,
java.lang.String logName,
java.lang.String versionProp)
|
protected |
QueryRefinementQos(Global glob,
java.lang.String tagName,
java.lang.String logName,
java.lang.String versionProp)
|
protected |
QueryRefinementQos(Global glob,
java.lang.String type,
java.lang.String version,
java.lang.String query,
java.lang.String tagName,
java.lang.String logName,
java.lang.String versionProp)
|
Method Summary | |
---|---|
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String name,
java.lang.StringBuffer character)
Handle SAX parsed end element |
Query |
getQuery()
Returns the query, the syntax is depending on what your plugin supports. |
java.lang.String |
getType()
Returns the plugins name. |
java.lang.String |
getVersion()
Returns the plugins version. |
void |
setQuery(Query query)
Set the filter query, it should fit to the protocol-type. |
void |
setType(java.lang.String type)
|
void |
setVersion(java.lang.String version)
|
boolean |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String name,
java.lang.StringBuffer character,
org.xml.sax.Attributes attrs)
Called for SAX filter start tag |
java.lang.String |
toXml()
Dump state of this object into a XML ASCII string. |
java.lang.String |
toXml(java.lang.String extraOffset)
Dump state of this object into a XML ASCII string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String ME
protected final Global glob
private static java.util.logging.Logger log
protected Query query
protected java.lang.String type
public static final java.lang.String DEFAULT_version
private java.lang.String version
protected java.lang.String tagName
protected java.lang.String logName
protected java.lang.String versionProp
Constructor Detail |
---|
protected QueryRefinementQos(Global glob, java.lang.String tagName, java.lang.String logName, java.lang.String versionProp)
protected QueryRefinementQos(Global glob, java.lang.String type, java.lang.String version, java.lang.String query, java.lang.String tagName, java.lang.String logName, java.lang.String versionProp)
glob
- The global handle holding environment and logging objectstype
- The plugin name, as used in xmlBlaster.properties e.g. "ContentLenFilter".version
- The plugin version, defaults to "1.0"query
- Your filter ruleprotected QueryRefinementQos(Global glob, java.lang.String type, java.lang.String version, Query query, java.lang.String tagName, java.lang.String logName, java.lang.String versionProp)
glob
- The global handle holding environment and logging objectstype
- The plugin name, as used in xmlBlaster.properties e.g. "ContentLenFilter".version
- The plugin version, defaults to "1.0"query
- Your filter ruleMethod Detail |
---|
public final void setType(java.lang.String type)
type
- The plugin name, as used in xmlBlaster.properties e.g. "ContentLenFilter".public final java.lang.String getType()
public final void setVersion(java.lang.String version)
version
- The version of the plugin, defaults to "1.0", but can anything you like.public final java.lang.String getVersion()
public final void setQuery(Query query)
query
- The filter query, e.g. "8000" for max length of a content with "ContentLenFilter" pluginpublic final Query getQuery()
public final boolean startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.StringBuffer character, org.xml.sax.Attributes attrs)
public final void endElement(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.StringBuffer character)
public final java.lang.String toXml()
public final java.lang.String toXml(java.lang.String extraOffset)
extraOffset
- indenting of tags for nice output
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |