com.yahoo.prelude.templates

Class FormattingOptions

java.lang.Object

com.yahoo.prelude.templates.FormattingOptions

public class FormattingOptions
extends Object

Defines formatting options used with special kinds of hits.

Author:

laboisse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	FormattingOptions.SubtypeField A structure that defines the tag name and attribute name for a field that sould be formatted as a field with a subtype.
(package private) static class	FormattingOptions.SubtypeFieldWithPrefix

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TYPE_ATTRIBUTE_NAME
private Map<String,String>	fieldsAsAttributes
private Set<String>	fieldsNotRendered
private Set<String>	fieldsRendered
private Map<String,FormattingOptions.SubtypeField>	fieldsWithSubtypes
private Map<String,FormattingOptions.SubtypeFieldWithPrefix>	prefixedFieldsWithSubtypes

Constructor Summary

Constructors

Constructor and Description
FormattingOptions()

Method Summary

Modifier and Type	Method and Description
Set<Map.Entry<String,String>>	fieldsAsAttributes()
void	formatFieldAsAttribute(String fieldName, String attributeName) Tells to format a field as an attribute of the hit's tag.
void	formatFieldWithSubtype(String fieldNamePrefix, String tagName, String typeAttributeName) Same as formatFieldWithSubtype(String, String, String, String) except that fields are selected based on the beginning of their name and the type attribute value is deduced from the rest of their name.
void	formatFieldWithSubtype(String fieldName, String tagName, String typeAttributeName, String typeAttributeValue) Tells to format a field using a subtype.
String	getAttributeName(String fieldName)
FormattingOptions.SubtypeField	getSubtype(String fieldName)
FormattingOptions.SubtypeFieldWithPrefix	getSubtypeWithPrefix(String fieldName)
void	setFieldNotToRender(String fieldName) Tells a field should not be rendered.
void	setFieldToRender(String fieldName) Tells a field should be rendered.
boolean	shouldRenderField(String fieldName) Tells whether a field should be rendered.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TYPE_ATTRIBUTE_NAME

public static final String DEFAULT_TYPE_ATTRIBUTE_NAME

See Also:

Constant Field Values

fieldsAsAttributes

private Map<String,String> fieldsAsAttributes

fieldsWithSubtypes

private Map<String,FormattingOptions.SubtypeField> fieldsWithSubtypes

prefixedFieldsWithSubtypes

private Map<String,FormattingOptions.SubtypeFieldWithPrefix> prefixedFieldsWithSubtypes

fieldsNotRendered

private Set<String> fieldsNotRendered

fieldsRendered

private Set<String> fieldsRendered

Constructor Detail

FormattingOptions

public FormattingOptions()

Method Detail

formatFieldAsAttribute

public void formatFieldAsAttribute(String fieldName,
                                   String attributeName)

Tells to format a field as an attribute of the hit's tag. For instance, field 'query-latency' could be rendered as an attribute 'latency' by invoking formatFieldAsAttribute("query-latency", "latency"). Output would be:

  <hit latency="100"></hit>
  

instead of:

  <hit><latency>100</latency></hit>
  

fieldsAsAttributes

public Set<Map.Entry<String,String>> fieldsAsAttributes()

getAttributeName

public String getAttributeName(String fieldName)

formatFieldWithSubtype

public void formatFieldWithSubtype(String fieldName,
                                   String tagName,
                                   String typeAttributeName,
                                   String typeAttributeValue)

Tells to format a field using a subtype. A subtype is used when there is kind of a grouping for a set of fields. For instance, fields 'latency-connect', 'latency-finish' all belong to the same 'latency' logical group. So invoking formatFieldWithSubtype("latency-connect", "latency", "type", "connect", formatFieldWithSubtype("latency-finish", "latency", "type", "connect" and so on, allows to have a common 'latency' tag name for all fields of the same kind. Note that it does no collapsing on tags. Output would be:

 <latency type="connect">50</latency>
 <latency type="finish">250</latency>
 

Instead of:

 <hit>
   <latency-connect>50</latency-connect>
   <latency-finish>50</latency-finish>
 

getSubtype

public FormattingOptions.SubtypeField getSubtype(String fieldName)

formatFieldWithSubtype

public void formatFieldWithSubtype(String fieldNamePrefix,
                                   String tagName,
                                   String typeAttributeName)

Same as formatFieldWithSubtype(String, String, String, String) except that fields are selected based on the beginning of their name and the type attribute value is deduced from the rest of their name. So this may select many fields instead of only one. Invoking formatFieldWithSubtype("latency-", "latency", "type") only once allows to have a common 'latency' tag name for all fields that start with 'latency-'. Type attribute value will be 'start' for field 'latency-start'. Note that it does no collapsing on tags. This is mostly used when you don't know all field names ahead. Output would be:

 <latency type="connect">50</latency>
 <latency type="finish">250</latency>
 

Instead of:

 <hit>
   <latency-connect>50</latency-connect>
   <latency-finish>50</latency-finish>
 

Note: don't use this with prefixes that start with a common substring (e.g. 'http', 'http_proxy'), I can tell you it just won't work.

getSubtypeWithPrefix

public FormattingOptions.SubtypeFieldWithPrefix getSubtypeWithPrefix(String fieldName)

shouldRenderField

public boolean shouldRenderField(String fieldName)

Tells whether a field should be rendered.

See Also:

setFieldNotToRender(String), setFieldToRender(String)

setFieldToRender

public void setFieldToRender(String fieldName)

Tells a field should be rendered.

Note: if at least one field is set to render, then only these fields should be rendered. Use setFieldNotToRender(String) to only exclude specific fields.

setFieldNotToRender

public void setFieldNotToRender(String fieldName)

Tells a field should not be rendered.

Note: all other fields should be rendered. Use setFieldToRender(String) to only include specific fields.