PhoneLetterCombinationGenerator

java.lang.Object

org.drip.service.common.PhoneLetterCombinationGenerator

public class PhoneLetterCombinationGenerator
extends java.lang.Object

PhoneLetterCombinationGenerator generates the Phone Letter Combinations. It implements the following Functions:

Generate the Standard PhoneLetterCombinationGenerator
PhoneLetterCombinationGenerator Constructor
Retrieve the Digit to Character Array Map
Generate the Set of Candidate Characters from the specified Digit and its Count
Generate all the Candidate Sequence Sets, given the Phone Number

Module	Computational Core Module
Library	Computation Support
Project	Environment, Product/Definition Containers, and Scenario/State Manipulation APIs
Package	Assorted Data Structures Support Utilities

Author:: Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor Description

PhoneLetterCombinationGenerator(java.util.Map<java.lang.Character,char[]> digitCharacterMap)
PhoneLetterCombinationGenerator Constructor

Method Summary

Modifier and Type	Method	Description
`java.util.Set<java.lang.String>`	`candidateCharacterSet(char digit, int count)`	Generate the Set of Candidate Characters from the specified Digit and its Count
`java.util.Map<java.lang.Character,char[]>`	`digitCharacterMap()`	Retrieve the Digit to Character Array Map
`java.util.Set<java.lang.String>`	`sequenceSet(java.lang.String number)`	Generate all the Candidate Sequence Sets, given the Phone Number.
`static PhoneLetterCombinationGenerator`	`Standard()`	Generate the Standard PhoneLetterCombinationGenerator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PhoneLetterCombinationGenerator
  
  public PhoneLetterCombinationGenerator(java.util.Map<java.lang.Character,char[]> digitCharacterMap) throws java.lang.Exception
  
  PhoneLetterCombinationGenerator Constructor
  
  Parameters:
  
  digitCharacterMap - The Digit To Character Array Map
  
  Throws:
  
  java.lang.Exception - Thrown if the Input is Invalid
Method Details
- Standard
  
  public static final PhoneLetterCombinationGenerator Standard()
  
  Generate the Standard PhoneLetterCombinationGenerator
  
  Returns:
  
  The Standard PhoneLetterCombinationGenerator
- digitCharacterMap
  
  public java.util.Map<java.lang.Character,char[]> digitCharacterMap()
  
  Retrieve the Digit to Character Array Map
  
  Returns:
  
  Digit to Character Array Map
- candidateCharacterSet
  
  public java.util.Set<java.lang.String> candidateCharacterSet(char digit, int count)
  
  Generate the Set of Candidate Characters from the specified Digit and its Count
  
  Parameters:
  
  digit - Digit
  
  count - Count of the Digit
  
  Returns:
  
  Set of Candidate Characters
- sequenceSet
  
  public java.util.Set<java.lang.String> sequenceSet(java.lang.String number)
  
  Generate all the Candidate Sequence Sets, given the Phone Number.
  
  Parameters:
  
  number - The Input Phone Number
  
  Returns:
  
  The Candidate Sequence Sets