Home >	Contents >	Index >

Expanded TOC   |    Purpose TOC   |    Annotated TOC   |    Index

RichTextConstraint

An input to a SearchState object.

Methods

new RichTextConstraint()

Constructor method that instantiates the RichTextConstraint object and creates methods that can be called on it. In turn, the RichTextConstraint object can be added to the SearchState object.

setBUCKET(java.lang.String BUCKET)

Sets the value for the BUCKET parameter. This method has a corresponding get method.

setTYPENAME(java.lang.String TYPENAME)

Sets the value for the TYPENAME parameter. This method has a corresponding get method.

setATTRIBUTE(java.lang.String ATTRIBUTE)

Sets the value for the ATTRIBUTE parameter. This method has a corresponding get method.

setVALUE(java.lang.String VALUE)

Sets the value for the VALUE parameter. This method has a corresponding get method.

setPARSER(java.lang.String PARSER)

Sets the value for the PARSER parameter. This method has a corresponding get method.

setCONFIDENCE(java.lang.String CONFIDENCE)

Sets the value for the CONFIDENCE parameter. This method has a corresponding get method.

setMAXCOUNT(java.lang.String MAXCOUNT)

Sets the value for the MAXCOUNT parameter. This method has a corresponding get method.

Parameters

BUCKET (optional)

Input parameter. The bucket name. If not specified, the attribute name is used.

TYPENAME (optional)

Input parameter. The internal asset name for the attribute (either CAttributes for content attribute, or PAttributes for product attribute). If you do not specify TYPENAME, a value is supplied from a property in the gator.ini property file: mwb.defaultattributes=PAttributes. The default is PAttributes and the value may be changed.

ATTRIBUTE (required)

Input parameter. Name of the attribute to constrain.

VALUE (required)

Input parameter. The rich-text search criteria, which should apply to the attribute.

PARSER (optional)

Input parameter. The search-engine-dependent rich text parser to use.

CONFIDENCE (required)

Input parameter. The minimum confidence level for the match. This parameter is search engine dependent; adjust the value lower if you are not getting the desired results.

MAXCOUNT (optional)

Input parameter. The maximum number of answers desired for the match. If this parameter is not specified, the number of results is limited only by the confidence and the number of products.

Description

Associated methods set parameter values that populate the RichTextConstraint object. The RichTextConstraint object can be added to the SearchState object with the correponding SearchState methods.

Adds an index name and rich-text expression to the list of rich-text criteria for items. If the attribute name is already mentioned as part of a rich-text constraint in the SearchState, then the existing constraint is removed first.This tag requires that the attribute was created as indexed.

Example

This code instantiates a RichTextConstraint object and set the TYPENAME and ATTRIBUTE parameters.

RichTextConstraint richtext_cons = new RichTextConstraint();
richtext_cons.setTYPENAME("PAttributes");
richtext_cons.setATTRIBUTE("FundFamily");

See Also

Methods for adding various constraint objects to a SearchState. These are available when you instantiate the SearchState object.

LikeConstraint

NestedConstraint

RangeConstraint

StandardConstraint

 

		Home >	Contents >	Index >
	FatWire Web Services Reference Copyright 2005,2006,2007 by FatWire Software All rights reserved.