Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.cloudsearch.model
Class SourceDataTrimTitle

java.lang.Object
  extended by com.amazonaws.services.cloudsearch.model.SourceDataTrimTitle
All Implemented Interfaces:
Serializable

public class SourceDataTrimTitle
extends Object
implements Serializable

Specifies how to trim common words from the beginning of a field to enable title sorting by that field.

See Also:
Serialized Form

Constructor Summary
SourceDataTrimTitle()
           
 
Method Summary
 boolean equals(Object obj)
           
 String getDefaultValue()
          The value of a field or source document attribute.
 String getLanguage()
          An IETF RFC 4646 language code.
 String getSeparator()
          The separator that follows the text to trim.
 String getSourceName()
          The name of the document source field to add to this IndexField.
 int hashCode()
           
 void setDefaultValue(String defaultValue)
          The value of a field or source document attribute.
 void setLanguage(String language)
          An IETF RFC 4646 language code.
 void setSeparator(String separator)
          The separator that follows the text to trim.
 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.
 SourceDataTrimTitle withDefaultValue(String defaultValue)
          The value of a field or source document attribute.
 SourceDataTrimTitle withLanguage(String language)
          An IETF RFC 4646 language code.
 SourceDataTrimTitle withSeparator(String separator)
          The separator that follows the text to trim.
 SourceDataTrimTitle withSourceName(String sourceName)
          The name of the document source field to add to this IndexField.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SourceDataTrimTitle

public SourceDataTrimTitle()
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 SourceDataTrimTitle 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 value of a field or source document attribute.

Constraints:
Length: 0 - 1024

Returns:
The value of a field or source document attribute.

setDefaultValue

public void setDefaultValue(String defaultValue)
The value of a field or source document attribute.

Constraints:
Length: 0 - 1024

Parameters:
defaultValue - The value of a field or source document attribute.

withDefaultValue

public SourceDataTrimTitle withDefaultValue(String defaultValue)
The value of a field or source document attribute.

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

Constraints:
Length: 0 - 1024

Parameters:
defaultValue - The value of a field or source document attribute.
Returns:
A reference to this updated object so that method calls can be chained together.

getSeparator

public String getSeparator()
The separator that follows the text to trim.

Returns:
The separator that follows the text to trim.

setSeparator

public void setSeparator(String separator)
The separator that follows the text to trim.

Parameters:
separator - The separator that follows the text to trim.

withSeparator

public SourceDataTrimTitle withSeparator(String separator)
The separator that follows the text to trim.

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

Parameters:
separator - The separator that follows the text to trim.
Returns:
A reference to this updated object so that method calls can be chained together.

getLanguage

public String getLanguage()
An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*

Returns:
An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

setLanguage

public void setLanguage(String language)
An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*

Parameters:
language - An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

withLanguage

public SourceDataTrimTitle withLanguage(String language)
An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

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

Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*

Parameters:
language - An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.
Returns:
A reference to this updated 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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.