~s-friedemann/tomdroid/sshfs

<DT>All Implemented Interfaces: <DD><A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A>, <A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></DD>

101

</DL>

102

<HR>

103

<DL>

104

<DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.30">Soundex</A><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></DL>

105

</PRE>

106

107

108

Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a

109

general purpose scheme to find word with similar phonemes.

110

111

112

113

<DL>

114

<DT>Version:</DT>

115

<DD>$Id: Soundex.java 794026 2009-07-14 19:21:23Z ggregory $</DD>

116

<DT>Author:</DT>

117

<DD>Apache Software Foundation</DD>

118

</DL>

119

<HR>

120

121

122

123

124

125

126

127

128

Field Summary</TH>

129

</TR>

130

131

132

<CODE>static <A HREF="../../../../../org/apache/commons/codec/language/Soundex.html" title="class in org.apache.commons.codec.language">Soundex</A></CODE></TD>

133

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#US_ENGLISH">US_ENGLISH</A></CODE>

134

135

136

An instance of Soundex using the US_ENGLISH_MAPPING mapping.</TD>

137

</TR>

138

139

140

<CODE>static char[]</CODE></TD>

141

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#US_ENGLISH_MAPPING">US_ENGLISH_MAPPING</A></CODE>

142

143

144

This is a default mapping of the 26 letters used in US English.</TD>

145

</TR>

146

147

148

<CODE>static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></TD>

149

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#US_ENGLISH_MAPPING_STRING">US_ENGLISH_MAPPING_STRING</A></CODE>

150

151

152

This is a default mapping of the 26 letters used in US English.</TD>

153

</TR>

154

</TABLE>

155

156

157

158

159

160

161

162

Constructor Summary</TH>

163

</TR>

164

165

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#Soundex()">Soundex</A>()</CODE>

166

167

168

Creates an instance using US_ENGLISH_MAPPING</TD>

169

</TR>

170

171

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#Soundex(char[])">Soundex</A>(char[] mapping)</CODE>

172

173

174

Creates a soundex instance using the given mapping.</TD>

175

</TR>

176

177

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#Soundex(java.lang.String)">Soundex</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mapping)</CODE>

178

179

180

Creates a refined soundex instance using a custom mapping.</TD>

181

</TR>

182

</TABLE>

183

184

185

186

187

188

189

190

Method Summary</TH>

191

</TR>

192

193

194

195

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#difference(java.lang.String, java.lang.String)">difference</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> s1,

196

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> s2)</CODE>

197

198

199

Encodes the Strings and returns the number of characters in the two encoded Strings that are the same.</TD>

200

</TR>

201

202

203

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></TD>

204

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#encode(java.lang.Object)">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> pObject)</CODE>

205

206

207

Encodes an Object using the soundex algorithm.</TD>

208

</TR>

209

210

211

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></TD>

212

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#encode(java.lang.String)">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString)</CODE>

213

214

215

Encodes a String using the soundex algorithm.</TD>

216

</TR>

217

218

219

220

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#getMaxLength()">getMaxLength</A>()</CODE>

221

222

223

Deprecated. This feature is not needed since the encoding size must be constant. Will be removed in 2.0.</TD>

224

</TR>

225

226

227

228

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#setMaxLength(int)">setMaxLength</A>(int maxLength)</CODE>

229

230

231

Deprecated. This feature is not needed since the encoding size must be constant. Will be removed in 2.0.</TD>

232

</TR>

233

234

235

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></TD>

236

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#soundex(java.lang.String)">soundex</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> str)</CODE>

237

238

239

Retrieves the Soundex code for a given String object.</TD>

240

</TR>

241

</TABLE>

242

243

244

245

<TH ALIGN="left">Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></TH>

246

</TR>

247

248

<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>

249

</TR>

250

</TABLE>

251

252

253

254

255

256

257

258

259

260

Field Detail</TH>

261

</TR>

262

</TABLE>

263

264

265

US_ENGLISH_MAPPING_STRING</H3>

266

<PRE>

267

public static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.42">US_ENGLISH_MAPPING_STRING</A></PRE>

268

<DL>

269

<DD>This is a default mapping of the 26 letters used in US English. A value of <code>0</code> for a letter position

270

means do not encode.

271

272

(This constant is provided as both an implementation convenience and to allow Javadoc to pick

273

up the value for the constant values page.)

274

275

276

<DL>

277

<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#US_ENGLISH_MAPPING"><CODE>US_ENGLISH_MAPPING</CODE></A>,

278

<A HREF="../../../../../constant-values.html#org.apache.commons.codec.language.Soundex.US_ENGLISH_MAPPING_STRING">Constant Field Values</A></DL>

279

</DL>

280

<HR>

281

282

283

US_ENGLISH_MAPPING</H3>

284

<PRE>

285

public static final char[] <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.50">US_ENGLISH_MAPPING</A></PRE>

286

<DL>

287

<DD>This is a default mapping of the 26 letters used in US English. A value of <code>0</code> for a letter position

288

means do not encode.

289

290

<DL>

291

<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#Soundex(char[])"><CODE>Soundex(char[])</CODE></A></DL>

292

</DL>

293

<HR>

294

295

296

US_ENGLISH</H3>

297

<PRE>

298

public static final <A HREF="../../../../../org/apache/commons/codec/language/Soundex.html" title="class in org.apache.commons.codec.language">Soundex</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.57">US_ENGLISH</A></PRE>

299

<DL>

300

<DD>An instance of Soundex using the US_ENGLISH_MAPPING mapping.

301

302

<DL>

303

<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#US_ENGLISH_MAPPING"><CODE>US_ENGLISH_MAPPING</CODE></A></DL>

304

</DL>

305

306

307

308

309

310

311

312

Constructor Detail</TH>

313

</TR>

314

</TABLE>

315

316

317

Soundex</H3>

318

<PRE>

319

public <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.102">Soundex</A>()</PRE>

320

<DL>

321

<DD>Creates an instance using US_ENGLISH_MAPPING

322

323

<DL>

324

<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#Soundex(char[])"><CODE>Soundex(char[])</CODE></A>,

325

<A HREF="../../../../../org/apache/commons/codec/language/Soundex.html#US_ENGLISH_MAPPING"><CODE>US_ENGLISH_MAPPING</CODE></A></DL>

326

</DL>

327

<HR>

328

329

330

Soundex</H3>

331

<PRE>

332

public <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.116">Soundex</A>(char[] mapping)</PRE>

333

<DL>

334

<DD>Creates a soundex instance using the given mapping. This constructor can be used to provide an internationalized

335

mapping for a non-Western character set.

336

337

Every letter of the alphabet is "mapped" to a numerical value. This char array holds the values to which each

338

letter is mapped. This implementation contains a default map for US_ENGLISH

339

340

<DL>

341

<DT>Parameters:<DD><CODE>mapping</CODE> - Mapping array to use when finding the corresponding code for a given character</DL>

342

</DL>

343

<HR>

344

345

346

Soundex</H3>

347

<PRE>

348

public <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.129">Soundex</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mapping)</PRE>

349

<DL>

350

<DD>Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping,

351

and/or possibly provide an internationalized mapping for a non-Western character set.

352

353

<DL>

354

<DT>Parameters:<DD><CODE>mapping</CODE> - Mapping string to use when finding the corresponding code for a given character<DT>Since:</DT>

355

356

</DL>

357

</DL>

358

359

360

361

362

363

364

365

Method Detail</TH>

366

</TR>

367

</TABLE>

368

369

370

difference</H3>

371

<PRE>

372

public int <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.79">difference</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> s1,

373

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> s2)

374

throws <A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>

375

<DL>

376

<DD>Encodes the Strings and returns the number of characters in the two encoded Strings that are the same. This

377

return value ranges from 0 through 4: 0 indicates little or no similarity, and 4 indicates strong similarity or

378

identical values.

379

380

381

</DL>

382

</DD>

383

384

<DT>Parameters:<DD><CODE>s1</CODE> - A String that will be encoded and compared.<DD><CODE>s2</CODE> - A String that will be encoded and compared.

385

<DT>Returns:<DD>The number of characters in the two encoded Strings that are the same from 0 to 4.

386

<DT>Throws:

387

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - if an error occurs encoding one of the strings<DT>Since:</DT>

388

389

<DT>See Also:<DD><CODE>SoundexUtils.difference(StringEncoder,String,String)</CODE>,

390

<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/tsqlref/ts_de-dz_8co5.asp"> MS

391

T-SQL DIFFERENCE </a></DL>

392

</DD>

393

</DL>

394

<HR>

395

396

397

encode</H3>

398

<PRE>

399

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.146">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> pObject)

400

throws <A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>

401

<DL>

402

<DD>Encodes an Object using the soundex algorithm. This method is provided in order to satisfy the requirements of

403

the Encoder interface, and will throw an EncoderException if the supplied object is not of type java.lang.String.

404

405

406

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/Encoder.html#encode(java.lang.Object)">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></CODE></DL>

407

</DD>

408

409

<DT>Parameters:<DD><CODE>pObject</CODE> - Object to encode

410

<DT>Returns:<DD>An object (or type java.lang.String) containing the soundex code which corresponds to the String

411

supplied.

412

<DT>Throws:

413

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - if the parameter supplied is not of type java.lang.String

414

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if a character is not mapped</DL>

415

</DD>

416

</DL>

417

<HR>

418

419

420

encode</H3>

421

<PRE>

422

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.162">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString)</PRE>

423

<DL>

424

<DD>Encodes a String using the soundex algorithm.

425

426

427

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/StringEncoder.html#encode(java.lang.String)">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></CODE></DL>

428

</DD>

429

430

<DT>Parameters:<DD><CODE>pString</CODE> - A String object to encode

431

<DT>Returns:<DD>A Soundex code corresponding to the String supplied

432

<DT>Throws:

433

434

</DD>

435

</DL>

436

<HR>

437

438

439

getMaxLength</H3>

440

<PRE>

441

public int <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.202">getMaxLength</A>()</PRE>

442

<DL>

443

<DD>Deprecated. This feature is not needed since the encoding size must be constant. Will be removed in 2.0.

444

445

<DD>Returns the maxLength. Standard Soundex

446

447

448

</DL>

449

</DD>

450

451

452

<DT>Returns:<DD>int</DL>

453

</DD>

454

</DL>

455

<HR>

456

457

458

setMaxLength</H3>

459

<PRE>

460

public void <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.239">setMaxLength</A>(int maxLength)</PRE>

461

<DL>

462

<DD>Deprecated. This feature is not needed since the encoding size must be constant. Will be removed in 2.0.

463

464

<DD>Sets the maxLength.

465

466

467

</DL>

468

</DD>

469

470

<DT>Parameters:<DD><CODE>maxLength</CODE> - The maxLength to set</DL>

471

</DD>

472

</DL>

473

<HR>

474

475

476

soundex</H3>

477

<PRE>

478

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Soundex.html#line.252">soundex</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> str)</PRE>

479

<DL>

480

<DD>Retrieves the Soundex code for a given String object.

481

482

483

</DL>

484

</DD>

485

486

<DT>Parameters:<DD><CODE>str</CODE> - String to encode using the Soundex algorithm

487

<DT>Returns:<DD>A soundex code for the String supplied

488

<DT>Throws:

489

490

</DD>

491

</DL>

492

493

<HR>

494

495

496

497

498

499

500

<TR>

501

502

503

504

505

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A> </TD>

506

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>

507

<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>

508

509

510

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A> </TD>

511

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A> </TD>

512

513

</TR>

514

</TABLE>

515

</TD>

516

517

518

</TD>

519

</TR>

520

521

<TR>

522

523

<A HREF="../../../../../org/apache/commons/codec/language/RefinedSoundex.html" title="class in org.apache.commons.codec.language">PREV CLASS</A>

524

NEXT CLASS</TD>

525

526

<A HREF="../../../../../index.html?org/apache/commons/codec/language/Soundex.html" target="_top">FRAMES</A>

527

<A HREF="Soundex.html" target="_top">NO FRAMES</A>

528

529

<!--

530

if(window==top) {

531

document.writeln('<A HREF="../../../../../allclasses-noframe.html">All Classes</A>');

532

}

533

//-->

534

</SCRIPT>

535

536

<A HREF="../../../../../allclasses-noframe.html">All Classes</A>

537

</NOSCRIPT>

538

539

540

</TD>

541

</TR>

542

<TR>

543

544

SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></TD>

545

546

DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></TD>

547

</TR>

548

</TABLE>

549

550

551

552

<HR>

553

554

</BODY>

555

</HTML>

Older »