atg.search.routing.command.search
Class FileExtensionConstraint

java.lang.Object
  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  FileExtensionConstraint createFromParser(atg.search.routing.utils.FastXMLModel pXml, int rootIdx)
           
 java.lang.String getFileExtension()
          Returns the file extension
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
 java.lang.String toXml()
          Converts this constraint to the XML representation that can be sent in request.
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, equals, escapeToXml, getParser, getPropConstraints, toString
 
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()

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

toXml

public java.lang.String toXml()
Description copied from class: DocumentSetConstraint
Converts this constraint to the XML representation that can be sent in request. You must override this to provide constraint-specific XML generation.

Specified by:
toXml in class DocumentSetConstraint
Returns:
xml

valueOf

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

createFromParser

protected FileExtensionConstraint createFromParser(atg.search.routing.utils.FastXMLModel pXml,
                                                   int rootIdx)
Specified by:
createFromParser in class DocumentSetConstraint