com.yahoo.search.query.profile

Class SubstituteString

java.lang.Object

com.yahoo.search.query.profile.SubstituteString

public class SubstituteString
extends Object

A string which contains one or more elements of the form %{name}, where these occurrences are to be replaced by a query profile lookup on name.

This objects does the analysis on creation and provides a (reasonably) fast method of performing the actual substitution (at lookup time).

This is a value object. Lookups in this are thread safe.

Author:

bratseth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SubstituteString.Component
private static class	SubstituteString.PropertyComponent
private static class	SubstituteString.StringComponent

Field Summary

Fields

Modifier and Type	Field and Description
private List<SubstituteString.Component>	components
private String	stringValue

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SubstituteString(List<SubstituteString.Component> components, String stringValue)

Method Summary

Modifier and Type	Method and Description
static SubstituteString	create(String value) Returns a new SubstituteString if the given string contains substitutions, null otherwise.
boolean	equals(Object other)
int	hashCode()
String	substitute(Map<String,String> context, com.yahoo.processing.request.Properties substitution) Perform the substitution in this, by looking up in the given query profile, and returns the resulting string
String	toString() Returns this string in original (unsubstituted) form

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

components

private final List<SubstituteString.Component> components

stringValue

private final String stringValue

Constructor Detail

SubstituteString

private SubstituteString(List<SubstituteString.Component> components,
                         String stringValue)

Method Detail

create

public static SubstituteString create(String value)

Returns a new SubstituteString if the given string contains substitutions, null otherwise.

substitute

public String substitute(Map<String,String> context,
                         com.yahoo.processing.request.Properties substitution)

Perform the substitution in this, by looking up in the given query profile, and returns the resulting string

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Returns this string in original (unsubstituted) form

Overrides:

toString in class Object