atg.search.routing.command.search
Class FileExtensionConstraint

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.DocumentSetConstraint
          extended by atg.search.routing.command.search.BaseConstraint
              extended by atg.search.routing.command.search.FileExtensionConstraint
All Implemented Interfaces:
java.io.Serializable

public class FileExtensionConstraint
extends BaseConstraint

Constraints the results based on the file extension of the indexed file.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
           
static java.lang.String TAG
           
 
Constructor Summary
FileExtensionConstraint()
           
 
Method Summary
protected  DocumentSetConstraint createFromParser(atg.search.routing.utils.SearchMessageNode pRoot)
           
 boolean equals(java.lang.Object pObject)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 java.lang.String getFileExtension()
          Returns the file extension
 java.lang.String getRequestTag()
           
static java.lang.String getTag()
           
 java.lang.Float getWeight()
          Returns the constraint's weight
 void setFileExtension(java.lang.String pFileExtension)
          Sets the file extension
 void setWeight(java.lang.Float pWeight)
          Sete the weight
static FileExtensionConstraint valueOf(java.lang.String pXml)
           
 
Methods inherited from class atg.search.routing.command.search.BaseConstraint
getXml, setXml
 
Methods inherited from class atg.search.routing.command.search.DocumentSetConstraint
createFromXML, getParser, getPropConstraints
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values

TAG

public static final java.lang.String TAG
See Also:
Constant Field Values
Constructor Detail

FileExtensionConstraint

public FileExtensionConstraint()
Method Detail

getTag

public static java.lang.String getTag()

equals

public boolean equals(java.lang.Object pObject)
Overrides:
equals in class java.lang.Object

getWeight

public java.lang.Float getWeight()
Returns the constraint's weight

Returns:
the constraint's weight

setFileExtension

public void setFileExtension(java.lang.String pFileExtension)
Sets the file extension

Parameters:
pFileExtension -

setWeight

public void setWeight(java.lang.Float pWeight)
Sete the weight

Parameters:
pWeight -

getFileExtension

public java.lang.String getFileExtension()
Returns the file extension

Returns:
the file extension

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException
Overrides:
getBodyXML in class atg.search.routing.command.SearchXMLObject
Throws:
atg.search.routing.command.IncompleteCommandException

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException
Overrides:
getAttributeXML in class atg.search.routing.command.SearchXMLObject
Throws:
atg.search.routing.command.IncompleteCommandException

valueOf

public static FileExtensionConstraint valueOf(java.lang.String pXml)

createFromParser

protected DocumentSetConstraint createFromParser(atg.search.routing.utils.SearchMessageNode pRoot)
Specified by:
createFromParser in class DocumentSetConstraint

getRequestTag

public java.lang.String getRequestTag()
Specified by:
getRequestTag in class atg.search.routing.command.SearchXMLObject