1 files changed, 58 insertions, 0 deletions
diff --git a/core/src/main/scala/com/rockymadden/stringmetric/StringMetric.scala b/core/src/main/scala/com/rockymadden/stringmetric/StringMetric.scala
new file mode 100644
index 0000000..f488141
--- /dev/null
+++ b/core/src/main/scala/com/rockymadden/stringmetric/StringMetric.scala
@@ -0,0 +1,58 @@
+package com.rockymadden.stringmetric
+
+import scala.language.implicitConversions
+
+trait StringMetric[A] extends Metric[Array[Char], A] {
+	def compare(a: String, b: String): Option[A]
+}
+
+object StringMetric {
+	val DiceSorensen = similarity.DiceSorensenMetric
+	val Hamming = similarity.HammingMetric
+	val Jaccard = similarity.JaccardMetric
+	val Jaro = similarity.JaroMetric
+	val JaroWinkler = similarity.JaroWinklerMetric
+	val Levenshtein = similarity.LevenshteinMetric
+	val Metaphone = phonetic.MetaphoneMetric
+	val NGram = similarity.NGramMetric
+	val Nysiis = phonetic.NysiisMetric
+	val Overlap = similarity.OverlapMetric
+	val RefinedNysiis = phonetic.RefinedNysiisMetric
+	val RefinedSoundex = phonetic.RefinedSoundexMetric
+	val Soundex = phonetic.SoundexMetric
+	val WeightedLevenshtein = similarity.WeightedLevenshteinMetric
+
+	implicit def toStringMetricDecorator[A](sa: StringMetric[A]): StringMetricDecorator[A] =
+		new StringMetricDecorator[A](sa)
+
+	def compareWithDiceSorensen(n: Int)(a: Array[Char], b: Array[Char]) = DiceSorensen(n).compare(a, b)
+
+	def compareWithHamming(a: Array[Char], b: Array[Char]) = Hamming.compare(a, b)
+
+	def compareWithJaccard(n: Int)(a: Array[Char], b: Array[Char]) = Jaccard(n).compare(a, b)
+
+	def compareWithJaro(a: Array[Char], b: Array[Char]) = Jaro.compare(a, b)
+
+	def compareWithJaroWinkler(a: Array[Char], b: Array[Char]) = JaroWinkler.compare(a, b)
+
+	def compareWithLevenshtein(a: Array[Char], b: Array[Char]) = Levenshtein.compare(a, b)
+
+	def compareWithMetaphone(a: Array[Char], b: Array[Char]) = Metaphone.compare(a, b)
+
+	def compareWithNGram(n: Int)(a: Array[Char], b: Array[Char]) = NGram(n).compare(a, b)
+
+	def compareWithNysiis(a: Array[Char], b: Array[Char]) = Nysiis.compare(a, b)
+
+	def compareWithOverlap(n: Int)(a: Array[Char], b: Array[Char]) = Overlap(n).compare(a, b)
+
+	def compareWithRefinedNysiis(a: Array[Char], b: Array[Char]) = RefinedNysiis.compare(a, b)
+
+	def compareWithRefinedSoundex(a: Array[Char], b: Array[Char]) = RefinedSoundex.compare(a, b)
+
+	def compareWithSoundex(a: Array[Char], b: Array[Char]) = Soundex.compare(a, b)
+
+	def compareWithWeightedLevenshtein(delete: BigDecimal, insert: BigDecimal, substitute: BigDecimal)
+		(a: Array[Char], b: Array[Char]) =
+
+		WeightedLevenshtein(delete, insert, substitute).compare(a, b)
+}