com.amazonaws.services.cloudsearch.model

Class SourceDataMap

java.lang.Object

com.amazonaws.services.cloudsearch.model.SourceDataMap

All Implemented Interfaces:

Serializable

public class SourceDataMap
extends Object
implements Serializable

Specifies how to map source attribute values to custom values when populating an IndexField .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SourceDataMap()

Method Summary

Methods

Modifier and Type	Method and Description
SourceDataMap	addCasesEntry(String key, String value) A map that translates source field values to custom values.
SourceDataMap	clearCasesEntries() Removes all the entries added into Cases.
boolean	equals(Object obj)
Map<String,String>	getCases() A map that translates source field values to custom values.
String	getDefaultValue() The default value to use if the source attribute is not specified in a document.
String	getSourceName() The name of the document source field to add to this IndexField.
int	hashCode()
void	setCases(Map<String,String> cases) A map that translates source field values to custom values.
void	setDefaultValue(String defaultValue) The default value to use if the source attribute is not specified in a document.
void	setSourceName(String sourceName) The name of the document source field to add to this IndexField.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SourceDataMap	withCases(Map<String,String> cases) A map that translates source field values to custom values.
SourceDataMap	withDefaultValue(String defaultValue) The default value to use if the source attribute is not specified in a document.
SourceDataMap	withSourceName(String sourceName) The name of the document source field to add to this IndexField.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceDataMap

public SourceDataMap()

Method Detail

getSourceName

public String getSourceName()

The name of the document source field to add to this IndexField.

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

Returns:

The name of the document source field to add to this IndexField.

setSourceName

public void setSourceName(String sourceName)

The name of the document source field to add to this IndexField.

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

Parameters:

sourceName - The name of the document source field to add to this IndexField.

withSourceName

public SourceDataMap withSourceName(String sourceName)

The name of the document source field to add to this IndexField.

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:

sourceName - The name of the document source field to add to this IndexField.

Returns:

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

getDefaultValue

public String getDefaultValue()

The default value to use if the source attribute is not specified in a document. Optional.

Constraints:
Length: 0 - 1024

Returns:

The default value to use if the source attribute is not specified in a document. Optional.

setDefaultValue

public void setDefaultValue(String defaultValue)

The default value to use if the source attribute is not specified in a document. Optional.

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - The default value to use if the source attribute is not specified in a document. Optional.

withDefaultValue

public SourceDataMap withDefaultValue(String defaultValue)

The default value to use if the source attribute is not specified in a document. Optional.

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

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - The default value to use if the source attribute is not specified in a document. Optional.

Returns:

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

getCases

public Map<String,String> getCases()

A map that translates source field values to custom values.

Returns:

A map that translates source field values to custom values.

setCases

public void setCases(Map<String,String> cases)

A map that translates source field values to custom values.

Parameters:

cases - A map that translates source field values to custom values.

withCases

public SourceDataMap withCases(Map<String,String> cases)

A map that translates source field values to custom values.

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

Parameters:

cases - A map that translates source field values to custom values.

Returns:

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

addCasesEntry

public SourceDataMap addCasesEntry(String key,
                          String value)

A map that translates source field values to custom values.

The method adds a new key-value pair into Cases parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Cases.

value - The corresponding value of the entry to be added into Cases.

clearCasesEntries

public SourceDataMap clearCasesEntries()

Removes all the entries added into Cases.

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

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