com.rockymadden.stringmetric.Algorithm.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stringmetric-core Show documentation

String metrics and phonetic algorithms for Scala.

The newest version!

package com.rockymadden.stringmetric

object Algorithm {
	import com.rockymadden.stringmetric.Transform.StringTransform


	trait Algorithm[A] {
		def compute(a: A): Option[A]
	}


	trait StringAlgorithm extends Algorithm[Array[Char]] {
		def compute(a: String): Option[String]
	}


	object StringAlgorithm {
		final val Metaphone = com.rockymadden.stringmetric.phonetic.MetaphoneAlgorithm
		final val Nysiis = com.rockymadden.stringmetric.phonetic.NysiisAlgorithm
		final val RefinedNysiis = com.rockymadden.stringmetric.phonetic.RefinedNysiisAlgorithm
		final val RefinedSoundex = com.rockymadden.stringmetric.phonetic.RefinedSoundexAlgorithm
		final val Soundex = com.rockymadden.stringmetric.phonetic.SoundexAlgorithm

		def computeWithMetaphone(a: Array[Char]) = Metaphone.compute(a)

		def computeWithNysiis(a: Array[Char]) = Nysiis.compute(a)

		def computeWithRefinedNysiis(a: Array[Char]) = RefinedNysiis.compute(a)

		def computeWithRefinedSoundex(a: Array[Char]) = RefinedSoundex.compute(a)

		def computeWithSoundex(a: Array[Char]) = Soundex.compute(a)
	}


	final class StringAlgorithmDecorator(val sa: StringAlgorithm) {
		val withTransform: (StringTransform => StringAlgorithm) = (st) => new StringAlgorithm {
			private[this] val self: StringAlgorithm = sa
			private[this] val transform: StringTransform = st

			override def compute(a: Array[Char]): Option[Array[Char]] = self.compute(transform(a))

			override def compute(a: String): Option[String] = self.compute(transform(a.toCharArray)).map(_.mkString)
		}
	}
}