com.yahoo.search.query.properties

Class PropertyAliases

java.lang.Object

com.yahoo.processing.request.Properties

com.yahoo.search.query.Properties

com.yahoo.search.query.properties.PropertyAliases

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

QueryPropertyAliases

public class PropertyAliases
extends Properties

A properties implementation which translates the incoming name to its standard name if it is a registered alias.

Aliases are case insensitive. One standard name may have multiple aliases.

This is multithread safe or not depending on the status of the passed map of aliases. Cloning will not deep copy the set of aliases.

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,com.yahoo.processing.request.CompoundName>	aliases A map from aliases to standard names

Constructor Summary

Constructors

Constructor and Description
PropertyAliases(Map<String,com.yahoo.processing.request.CompoundName> aliases) Creates an instance with a set of aliases.

Method Summary

Modifier and Type	Method and Description
Object	get(com.yahoo.processing.request.CompoundName name, Map<String,String> context, com.yahoo.processing.request.Properties substitution)
Map<String,Object>	listProperties(com.yahoo.processing.request.CompoundName property, Map<String,String> context, com.yahoo.processing.request.Properties substitution)
void	set(com.yahoo.processing.request.CompoundName name, Object value, Map<String,String> context)
protected com.yahoo.processing.request.CompoundName	unalias(com.yahoo.processing.request.CompoundName nameOrAlias) Returns the standard name for an alias, or the given name if it is not a registered alias

Methods inherited from class com.yahoo.search.query.Properties

chained, clone, getParentQuery, setParentQuery

Methods inherited from class com.yahoo.processing.request.Properties

asBoolean, asDouble, asInteger, asLong, asString, chain, clone, cloneMap, get, get, get, get, get, get, get, getBoolean, getBoolean, getBoolean, getBoolean, getDouble, getDouble, getDouble, getDouble, getInstance, getInteger, getInteger, getInteger, getInteger, getLong, getLong, getLong, getLong, getString, getString, getString, getString, listProperties, listProperties, listProperties, listProperties, listProperties, listProperties, listProperties, set, set, set

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

aliases

private final Map<String,com.yahoo.processing.request.CompoundName> aliases

A map from aliases to standard names

Constructor Detail

PropertyAliases

public PropertyAliases(Map<String,com.yahoo.processing.request.CompoundName> aliases)

Creates an instance with a set of aliases. The given aliases will be used directly by this class. To make this class immutable and thread safe, relinquish ownership of the parameter map.

Method Detail

unalias

protected com.yahoo.processing.request.CompoundName unalias(com.yahoo.processing.request.CompoundName nameOrAlias)

Returns the standard name for an alias, or the given name if it is not a registered alias

Parameters:

nameOrAlias - the name to check if is an alias

Returns:

the real name if an alias or the input name itself

listProperties

public Map<String,Object> listProperties(com.yahoo.processing.request.CompoundName property,
                                         Map<String,String> context,
                                         com.yahoo.processing.request.Properties substitution)

Overrides:

listProperties in class com.yahoo.processing.request.Properties

get

public Object get(com.yahoo.processing.request.CompoundName name,
                  Map<String,String> context,
                  com.yahoo.processing.request.Properties substitution)

Overrides:

get in class com.yahoo.processing.request.Properties

set

public void set(com.yahoo.processing.request.CompoundName name,
                Object value,
                Map<String,String> context)

Overrides:

set in class com.yahoo.processing.request.Properties