com.lowagie.text.pdf.hyphenation.Hyphenator Maven / Gradle / Ivy
/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.lowagie.text.pdf.hyphenation;
import com.lowagie.text.pdf.BaseFont;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.Hashtable;
import java.util.Map;
/**
* This class is the main entry point to the hyphenation package. You can use only the static methods or create an
* instance.
*
* @author Carlos Villegas
*/
public class Hyphenator {
private static final String defaultHyphLocation = "com/lowagie/text/pdf/hyphenation/hyph/";
/**
* TODO: Don't use statics
*/
private static Map hyphenTrees = new Hashtable<>();
/**
* Holds value of property hyphenDir.
*/
private static String hyphenDir = "";
private HyphenationTree hyphenTree = null;
private int remainCharCount = 2;
private int pushCharCount = 2;
/**
* @param lang The language
* @param country the Country
* @param leftMin The minimum letters on the left
* @param rightMin The minimum letters on the right
*/
public Hyphenator(String lang, String country, int leftMin,
int rightMin) {
hyphenTree = getHyphenationTree(lang, country);
remainCharCount = leftMin;
pushCharCount = rightMin;
}
/**
* @param lang The language
* @param country The country
* @return the hyphenation tree
*/
public static HyphenationTree getHyphenationTree(String lang,
String country) {
String key = lang;
// check whether the country code has been used
if (country != null && !country.equals("none")) {
key += "_" + country;
}
// first try to find it in the cache
if (hyphenTrees.containsKey(key)) {
return hyphenTrees.get(key);
}
if (hyphenTrees.containsKey(lang)) {
return hyphenTrees.get(lang);
}
HyphenationTree hTree = getResourceHyphenationTree(key);
if (hTree == null) {
hTree = getFileHyphenationTree(key);
}
// put it into the pattern cache
if (hTree != null) {
hyphenTrees.put(key, hTree);
}
return hTree;
}
/**
* @param key A String of the key of the hyphenation tree
* @return a hyphenation tree
*/
public static HyphenationTree getResourceHyphenationTree(String key) {
InputStream stream = readHyphenationFile(key);
if (stream == null) {
return null;
}
try (InputStream resourceStream = stream) {
HyphenationTree hTree = new HyphenationTree();
hTree.loadSimplePatterns(stream);
return hTree;
} catch (Exception e) {
return null;
}
}
private static InputStream readHyphenationFile(String key) {
InputStream stream = BaseFont.getResourceStream(defaultHyphLocation + key + ".xml");
if (stream == null && key.length() > 2) {
stream = BaseFont.getResourceStream(defaultHyphLocation + key.substring(0, 2) + ".xml");
}
return stream;
}
/**
* @param key The language to get the tree from
* @return a hyphenation tree or null
*/
public static HyphenationTree getFileHyphenationTree(String key) {
if (hyphenDir == null) {
return null;
}
File hyphenFile = getHyphenFile(key);
if (hyphenFile == null) {
return null;
}
try (InputStream stream = new FileInputStream(hyphenFile)) {
HyphenationTree hTree = new HyphenationTree();
hTree.loadSimplePatterns(stream);
return hTree;
} catch (Exception e) {
return null;
}
}
private static File getHyphenFile(String key) {
File hyphenFile = new File(hyphenDir, key + ".xml");
if (hyphenFile.canRead()) {
return hyphenFile;
}
if (key.length() > 2) {
hyphenFile = new File(hyphenDir, key.substring(0, 2) + ".xml");
if (hyphenFile.canRead()) {
return hyphenFile;
}
}
return null;
}
/**
* @param lang The language
* @param country The country
* @param word char array containing the word
* @param leftMin Minimum number of characters allowed before the hyphenation point
* @param rightMin Minimum number of characters allowed after the hyphenation point
* @return a hyphenation object
*/
public static Hyphenation hyphenate(String lang, String country,
String word, int leftMin,
int rightMin) {
HyphenationTree hTree = getHyphenationTree(lang, country);
if (hTree == null) {
//log.error("Error building hyphenation tree for language "
// + lang);
return null;
}
return hTree.hyphenate(word, leftMin, rightMin);
}
/**
* @param lang The language
* @param country The country
* @param word char array that contains the word to hyphenate
* @param offset Offset to the first character in word
* @param len The length of the word
* @param leftMin Minimum number of characters allowed before the hyphenation point
* @param rightMin Minimum number of characters allowed after the hyphenation point
* @return a hyphenation object
*/
public static Hyphenation hyphenate(String lang, String country,
char[] word, int offset, int len,
int leftMin, int rightMin) {
HyphenationTree hTree = getHyphenationTree(lang, country);
if (hTree == null) {
//log.error("Error building hyphenation tree for language "
// + lang);
return null;
}
return hTree.hyphenate(word, offset, len, leftMin, rightMin);
}
/**
* Getter for property hyphenDir.
*
* @return Value of property hyphenDir.
*/
public static String getHyphenDir() {
return hyphenDir;
}
/**
* Setter for property hyphenDir.
*
* @param _hyphenDir New value of property hyphenDir.
*/
public static void setHyphenDir(String _hyphenDir) {
hyphenDir = _hyphenDir;
}
/**
* @param min Minimum number of characters allowed before the hyphenation point
*/
public void setMinRemainCharCount(int min) {
remainCharCount = min;
}
/**
* @param min Minimum number of characters allowed after the hyphenation point
*/
public void setMinPushCharCount(int min) {
pushCharCount = min;
}
/**
* @param lang The language
* @param country The country
*/
public void setLanguage(String lang, String country) {
hyphenTree = getHyphenationTree(lang, country);
}
/**
* @param word Char array that contains the word
* @param offset Offset to the first character in word
* @param len Length of the word
* @return a hyphenation object
*/
public Hyphenation hyphenate(char[] word, int offset, int len) {
if (hyphenTree == null) {
return null;
}
return hyphenTree.hyphenate(word, offset, len, remainCharCount,
pushCharCount);
}
/**
* @param word The word to hyphenate
* @return a hyphenation object
*/
public Hyphenation hyphenate(String word) {
if (hyphenTree == null) {
return null;
}
return hyphenTree.hyphenate(word, remainCharCount, pushCharCount);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy