com.amazonaws.services.cloudsearch.model
Class SourceAttribute

java.lang.Object
  com.amazonaws.services.cloudsearch.model.SourceAttribute

public class SourceAttribute
extends java.lang.Object

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

Constructor Summary

SourceAttribute()

Method Summary

boolean	equals(java.lang.Object obj)
SourceData	getSourceDataCopy() Copies data from a source document attribute to an IndexField.
java.lang.String	getSourceDataFunction() Identifies the transformation to apply when copying data from a source attribute.
SourceDataMap	getSourceDataMap() Maps source document attribute values to new values when populating the IndexField.
SourceDataTrimTitle	getSourceDataTrimTitle() Trims common title words from a source document attribute when populating an IndexField.
int	hashCode()
void	setSourceDataCopy(SourceData sourceDataCopy) Copies data from a source document attribute to an IndexField.
void	setSourceDataFunction(SourceDataFunction sourceDataFunction) Identifies the transformation to apply when copying data from a source attribute.
void	setSourceDataFunction(java.lang.String sourceDataFunction) Identifies the transformation to apply when copying data from a source attribute.
void	setSourceDataMap(SourceDataMap sourceDataMap) Maps source document attribute values to new values when populating the IndexField.
void	setSourceDataTrimTitle(SourceDataTrimTitle sourceDataTrimTitle) Trims common title words from a source document attribute when populating an IndexField.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SourceAttribute	withSourceDataCopy(SourceData sourceDataCopy) Copies data from a source document attribute to an IndexField.
SourceAttribute	withSourceDataFunction(SourceDataFunction sourceDataFunction) Identifies the transformation to apply when copying data from a source attribute.
SourceAttribute	withSourceDataFunction(java.lang.String sourceDataFunction) Identifies the transformation to apply when copying data from a source attribute.
SourceAttribute	withSourceDataMap(SourceDataMap sourceDataMap) Maps source document attribute values to new values when populating the IndexField.
SourceAttribute	withSourceDataTrimTitle(SourceDataTrimTitle sourceDataTrimTitle) Trims common title words from a source document attribute when populating an IndexField.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SourceAttribute

public SourceAttribute()

Method Detail

getSourceDataFunction

public java.lang.String getSourceDataFunction()

Identifies the transformation to apply when copying data from a source attribute.

Constraints:
Allowed Values: Copy, TrimTitle, Map

Returns:

Identifies the transformation to apply when copying data from a source attribute.

See Also:

SourceDataFunction

setSourceDataFunction

public void setSourceDataFunction(java.lang.String sourceDataFunction)

Identifies the transformation to apply when copying data from a source attribute.

Constraints:
Allowed Values: Copy, TrimTitle, Map

Parameters:

sourceDataFunction - Identifies the transformation to apply when copying data from a source attribute.

See Also:

SourceDataFunction

withSourceDataFunction

public SourceAttribute withSourceDataFunction(java.lang.String sourceDataFunction)

Identifies the transformation to apply when copying data from a source attribute.

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

Constraints:
Allowed Values: Copy, TrimTitle, Map

Parameters:

sourceDataFunction - Identifies the transformation to apply when copying data from a source attribute.

Returns:

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

See Also:

SourceDataFunction

setSourceDataFunction

public void setSourceDataFunction(SourceDataFunction sourceDataFunction)

Identifies the transformation to apply when copying data from a source attribute.

Constraints:
Allowed Values: Copy, TrimTitle, Map

Parameters:

sourceDataFunction - Identifies the transformation to apply when copying data from a source attribute.

See Also:

SourceDataFunction

withSourceDataFunction

public SourceAttribute withSourceDataFunction(SourceDataFunction sourceDataFunction)

Identifies the transformation to apply when copying data from a source attribute.

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

Constraints:
Allowed Values: Copy, TrimTitle, Map

Parameters:

sourceDataFunction - Identifies the transformation to apply when copying data from a source attribute.

Returns:

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

See Also:

SourceDataFunction

getSourceDataCopy

public SourceData getSourceDataCopy()

Copies data from a source document attribute to an IndexField.

Returns:

Copies data from a source document attribute to an IndexField.

setSourceDataCopy

public void setSourceDataCopy(SourceData sourceDataCopy)

Copies data from a source document attribute to an IndexField.

Parameters:

sourceDataCopy - Copies data from a source document attribute to an IndexField.

withSourceDataCopy

public SourceAttribute withSourceDataCopy(SourceData sourceDataCopy)

Copies data from a source document attribute to an IndexField.

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

Parameters:

sourceDataCopy - Copies data from a source document attribute to an IndexField.

Returns:

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

getSourceDataTrimTitle

public SourceDataTrimTitle getSourceDataTrimTitle()

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

Returns:

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

setSourceDataTrimTitle

public void setSourceDataTrimTitle(SourceDataTrimTitle sourceDataTrimTitle)

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

Parameters:

sourceDataTrimTitle - Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

withSourceDataTrimTitle

public SourceAttribute withSourceDataTrimTitle(SourceDataTrimTitle sourceDataTrimTitle)

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

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

Parameters:

sourceDataTrimTitle - Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

Returns:

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

getSourceDataMap

public SourceDataMap getSourceDataMap()

Maps source document attribute values to new values when populating the IndexField.

Returns:

Maps source document attribute values to new values when populating the IndexField.

setSourceDataMap

public void setSourceDataMap(SourceDataMap sourceDataMap)

Maps source document attribute values to new values when populating the IndexField.

Parameters:

sourceDataMap - Maps source document attribute values to new values when populating the IndexField.

withSourceDataMap

public SourceAttribute withSourceDataMap(SourceDataMap sourceDataMap)

Maps source document attribute values to new values when populating the IndexField.

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

Parameters:

sourceDataMap - Maps source document attribute values to new values when populating the IndexField.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object