com.datastax.driver.mapping

Interface NamingConvention

All Known Implementing Classes:

NamingConventions.CamelCase, NamingConventions.CharDelimitedNamingConvention, NamingConventions.LowerCamelCase, NamingConventions.SingleWordNamingConvention, NamingConventions.UpperCamelCase

public interface NamingConvention

Represent a naming convention (e.g. snake_case, camelCase, etc...) to be used when auto-translating java property names to cassandra column names and vice versa.

This interface may be implemented to define custom naming convention.

Method Summary

Modifier and Type	Method and Description
String	join(List<Word> input) Receive an ordered list of Word objects and returns a result property name.
List<Word>	split(String input) Receive a property name value and returns an ordered list of Word objects.

Method Detail

split

List<Word> split(String input)

Receive a property name value and returns an ordered list of Word objects. Each word contains a String value and a boolean indicating whether or not the value is an abbreviation (In most cases could not be determined). Quick examples:

• Let's consider lowerCamelCase convention and input = "myXMLParser", then the output should be: [ word{value = "my", isAbbreviation = false}, word{value = "xml", isAbbreviation = true}, word{value = "parser", isAbbreviation = false} ]
• Let's consider lower_snake_case convention and input = "myXMLParser", then the output may be (since there's no trivial way to determine xml to an abbreviation): [ word{value = "my", isAbbreviation = false}, word{value = "xml", isAbbreviation = false}, word{value = "parser", isAbbreviation = false} ]

Parameters:

input - value to split

Returns:

an ordered list of split Word objects

join

String join(List<Word> input)

Receive an ordered list of Word objects and returns a result property name. Quick examples:

• Let's consider lowerCamelCase convention with upperCaseAbbreviations set to false, and input = [ word{value = "my", isAbbreviation = false}, word{value = "xml", isAbbreviation = true}, word{value = "parser", isAbbreviation = false} ] then the output should be "myXmlParser".
• Let's consider upperCamelCase convention with upperCaseAbbreviations set to true, and input = [ word{value = "my", isAbbreviation = false}, word{value = "xml", isAbbreviation = true}, word{value = "parser", isAbbreviation = false} ] then the output should be "MyXMLParser".

Parameters:

input - list to translate

Returns:

the result property name