com.amazonaws.services.cloudsearchv2.model
Class DoubleOptions

java.lang.Object
  com.amazonaws.services.cloudsearchv2.model.DoubleOptions

All Implemented Interfaces:

Serializable

public class DoubleOptions
extends Object
implements Serializable

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double . All options are enabled by default.

See Also:

Serialized Form

Constructor Summary

DoubleOptions()

Method Summary

boolean	equals(Object obj)
Double	getDefaultValue() A value to use for the field if the field isn't specified for a document.
Boolean	getFacetEnabled() Whether facet information can be returned for the field.
Boolean	getReturnEnabled() Whether the contents of the field can be returned in the search results.
Boolean	getSearchEnabled() Whether the contents of the field are searchable.
Boolean	getSortEnabled() Whether the field can be used to sort the search results.
String	getSourceField() The name of the source field to map to the field.
int	hashCode()
Boolean	isFacetEnabled() Whether facet information can be returned for the field.
Boolean	isReturnEnabled() Whether the contents of the field can be returned in the search results.
Boolean	isSearchEnabled() Whether the contents of the field are searchable.
Boolean	isSortEnabled() Whether the field can be used to sort the search results.
void	setDefaultValue(Double defaultValue) A value to use for the field if the field isn't specified for a document.
void	setFacetEnabled(Boolean facetEnabled) Whether facet information can be returned for the field.
void	setReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
void	setSearchEnabled(Boolean searchEnabled) Whether the contents of the field are searchable.
void	setSortEnabled(Boolean sortEnabled) Whether the field can be used to sort the search results.
void	setSourceField(String sourceField) The name of the source field to map to the field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DoubleOptions	withDefaultValue(Double defaultValue) A value to use for the field if the field isn't specified for a document.
DoubleOptions	withFacetEnabled(Boolean facetEnabled) Whether facet information can be returned for the field.
DoubleOptions	withReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
DoubleOptions	withSearchEnabled(Boolean searchEnabled) Whether the contents of the field are searchable.
DoubleOptions	withSortEnabled(Boolean sortEnabled) Whether the field can be used to sort the search results.
DoubleOptions	withSourceField(String sourceField) The name of the source field to map to the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleOptions

public DoubleOptions()

Method Detail

getDefaultValue

public Double getDefaultValue()

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Returns:

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

setDefaultValue

public void setDefaultValue(Double defaultValue)

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Parameters:

defaultValue - A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

withDefaultValue

public DoubleOptions withDefaultValue(Double defaultValue)

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Returns a reference to this object so that method calls can be chained together.

Parameters:

defaultValue - A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceField

public String getSourceField()

The name of the source field to map to the field.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Returns:

The name of the source field to map to the field.

setSourceField

public void setSourceField(String sourceField)

The name of the source field to map to the field.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

sourceField - The name of the source field to map to the field.

withSourceField

public DoubleOptions withSourceField(String sourceField)

The name of the source field to map to the field.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

sourceField - The name of the source field to map to the field.

Returns:

A reference to this updated object so that method calls can be chained together.

isFacetEnabled

public Boolean isFacetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

setFacetEnabled

public void setFacetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

Parameters:

facetEnabled - Whether facet information can be returned for the field.

withFacetEnabled

public DoubleOptions withFacetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

Returns a reference to this object so that method calls can be chained together.

Parameters:

facetEnabled - Whether facet information can be returned for the field.

Returns:

A reference to this updated object so that method calls can be chained together.

getFacetEnabled

public Boolean getFacetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

isSearchEnabled

public Boolean isSearchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

setSearchEnabled

public void setSearchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

Parameters:

searchEnabled - Whether the contents of the field are searchable.

withSearchEnabled

public DoubleOptions withSearchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

Returns a reference to this object so that method calls can be chained together.

Parameters:

searchEnabled - Whether the contents of the field are searchable.

Returns:

A reference to this updated object so that method calls can be chained together.

getSearchEnabled

public Boolean getSearchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

isReturnEnabled

public Boolean isReturnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

setReturnEnabled

public void setReturnEnabled(Boolean returnEnabled)

Whether the contents of the field can be returned in the search results.

Parameters:

returnEnabled - Whether the contents of the field can be returned in the search results.

withReturnEnabled

public DoubleOptions withReturnEnabled(Boolean returnEnabled)

Whether the contents of the field can be returned in the search results.

Returns a reference to this object so that method calls can be chained together.

Parameters:

returnEnabled - Whether the contents of the field can be returned in the search results.

Returns:

A reference to this updated object so that method calls can be chained together.

getReturnEnabled

public Boolean getReturnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

isSortEnabled

public Boolean isSortEnabled()

Whether the field can be used to sort the search results.

Returns:

Whether the field can be used to sort the search results.

setSortEnabled

public void setSortEnabled(Boolean sortEnabled)

Whether the field can be used to sort the search results.

Parameters:

sortEnabled - Whether the field can be used to sort the search results.

withSortEnabled

public DoubleOptions withSortEnabled(Boolean sortEnabled)

Whether the field can be used to sort the search results.

Returns a reference to this object so that method calls can be chained together.

Parameters:

sortEnabled - Whether the field can be used to sort the search results.

Returns:

A reference to this updated object so that method calls can be chained together.

getSortEnabled

public Boolean getSortEnabled()

Whether the field can be used to sort the search results.

Returns:

Whether the field can be used to sort the search results.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object