net.sf.okapi.steps.translationcomparison.TranslationComparisonStep Maven / Gradle / Ivy
/*===========================================================================
Copyright (C) 2009-2013 by the Okapi Framework contributors
-----------------------------------------------------------------------------
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 net.sf.okapi.steps.translationcomparison;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import net.sf.okapi.common.Event;
import net.sf.okapi.common.EventType;
import net.sf.okapi.common.IParameters;
import net.sf.okapi.common.LocaleId;
import net.sf.okapi.common.UsingParameters;
import net.sf.okapi.common.Util;
import net.sf.okapi.common.XMLWriter;
import net.sf.okapi.common.annotation.AltTranslation;
import net.sf.okapi.common.annotation.AltTranslationsAnnotation;
import net.sf.okapi.common.exceptions.OkapiException;
import net.sf.okapi.common.filters.IFilter;
import net.sf.okapi.common.filters.IFilterConfigurationMapper;
import net.sf.okapi.common.filterwriter.GenericContent;
import net.sf.okapi.common.filterwriter.TMXWriter;
import net.sf.okapi.common.pipeline.BasePipelineStep;
import net.sf.okapi.common.pipeline.annotations.StepParameterMapping;
import net.sf.okapi.common.pipeline.annotations.StepParameterType;
import net.sf.okapi.common.resource.ITextUnit;
import net.sf.okapi.common.resource.Property;
import net.sf.okapi.common.resource.RawDocument;
import net.sf.okapi.common.resource.StartDocument;
import net.sf.okapi.common.resource.TextContainer;
import net.sf.okapi.common.resource.TextFragment;
import net.sf.okapi.common.resource.TextUnit;
import net.sf.okapi.lib.search.lucene.analysis.NgramAnalyzer;
import net.sf.okapi.lib.translation.TextMatcher;
import net.sf.okapi.steps.wordcount.common.GMX;
import net.sf.okapi.steps.wordcount.common.Metrics;
import net.sf.okapi.steps.wordcount.common.MetricsAnnotation;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.TokenStream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@UsingParameters(Parameters.class)
public class TranslationComparisonStep extends BasePipelineStep {
private final Logger logger = LoggerFactory.getLogger(getClass());
private final String WIKIURL = "http://okapiframework.org/wiki/index.php?title=Translation_Comparison_Step";
private Parameters params;
private IFilter filter2;
private IFilter filter3;
private TextMatcher matcher;
private XMLWriter writer;
private TMXWriter tmx;
private PrintWriter prnWriter;
private boolean isBaseMultilingual;
private boolean isInput2Multilingual;
private boolean isInput3Multilingual;
private String pathToOpen;
private int options;
private Property deScore1to2Prop;
private Property deScore1to3Prop;
private Property fmScore1to2Prop;
private Property fmScore1to3Prop;
private long deScoreTotal1to2;
private long deScoreTotal1to3;
private long deScoreTotal2to3;
private long fmScoreTotal1to2;
private long fmScoreTotal1to3;
private long fmScoreTotal2to3;
private int itemCount;
private String baseDocumentPath;
private String compDocumentPath;
private IFilterConfigurationMapper fcMapper;
private LocaleId targetLocale;
private LocaleId targetLocale2Extra;
private LocaleId targetLocale3Extra;
private LocaleId sourceLocale;
private URI inputURI;
private RawDocument rawDoc2;
private RawDocument rawDoc3;
private GenericContent fmt;
private String rootDir;
private String inputRootDir;
private Analyzer triGramAnalyzer; // trigram analyzer to be used for FM-Score calculation
private SimpleDateFormat df;
private long wcTotal;
private long[] edBrackets = new long[11];
private long[] edWCBrackets = new long[11];
private long[] fmBrackets = new long[11];
private long[] fmWCBrackets = new long[11];
private long edScoreWordTotal;
private long fmScoreWordTotal;
public TranslationComparisonStep () {
params = new Parameters();
fmt = new GenericContent();
}
@StepParameterMapping(parameterType = StepParameterType.FILTER_CONFIGURATION_MAPPER)
public void setFilterConfigurationMapper (IFilterConfigurationMapper fcMapper) {
this.fcMapper = fcMapper;
}
@StepParameterMapping(parameterType = StepParameterType.SOURCE_LOCALE)
public void setSourceLocale (LocaleId sourceLocale) {
this.sourceLocale = sourceLocale;
}
@SuppressWarnings("deprecation")
@StepParameterMapping(parameterType = StepParameterType.TARGET_LOCALE)
public void setTargetLocale (LocaleId targetLocale) {
this.targetLocale = targetLocale;
}
@StepParameterMapping(parameterType = StepParameterType.INPUT_URI)
public void setInputURI (URI inputURI) {
this.inputURI = inputURI;
}
@StepParameterMapping(parameterType = StepParameterType.SECOND_INPUT_RAWDOC)
public void setSecondInput (RawDocument secondInput) {
this.rawDoc2 = secondInput;
}
@StepParameterMapping(parameterType = StepParameterType.THIRD_INPUT_RAWDOC)
public void setThirdInput (RawDocument thirdInput) {
this.rawDoc3 = thirdInput;
}
@StepParameterMapping(parameterType = StepParameterType.ROOT_DIRECTORY)
public void setRootDirectory (String rootDir) {
this.rootDir = rootDir;
}
@StepParameterMapping(parameterType = StepParameterType.INPUT_ROOT_DIRECTORY)
public void setInputRootDirectory (String inputRootDir) {
this.inputRootDir = inputRootDir;
}
@Override
public String getName () {
return "Translation Comparison";
}
@Override
public String getDescription () {
return "Compare the translated text units between several documents. "
+ "Expects: filter events. Sends back: filter events.";
}
@Override
public Parameters getParameters () {
return params;
}
@Override
public void setParameters (IParameters params) {
this.params = (Parameters)params;
}
@Override
protected Event handleStartBatch (Event event) {
// Both strings are in the target language.
matcher = new TextMatcher(targetLocale, targetLocale);
// Start TMX writer (one for all input documents)
if ( params.isGenerateTMX() ) {
String resolvedPath = Util.fillRootDirectoryVariable(params.getTmxPath(), rootDir);
resolvedPath = Util.fillInputRootDirectoryVariable(resolvedPath, inputRootDir);
resolvedPath = LocaleId.replaceVariables(resolvedPath, sourceLocale, targetLocale);
tmx = new TMXWriter(resolvedPath);
tmx.writeStartDocument(sourceLocale, targetLocale,
getClass().getName(), null, null, null, null);
}
pathToOpen = null;
deScore1to2Prop = new Property("Txt::EDScore", "", false);
fmScore1to2Prop = new Property("Txt::FMScore", "", false);
targetLocale2Extra = LocaleId.fromString(targetLocale.toString()+params.getTarget2Suffix());
deScore1to3Prop = new Property("Txt::EDScore1to3", "", false);
fmScore1to3Prop = new Property("Txt::FMScore1to3", "", false);
targetLocale3Extra = LocaleId.fromString(targetLocale.toString()+params.getTarget3Suffix());
options = 0;
if ( !params.isCaseSensitive() ) options |= TextMatcher.IGNORE_CASE;
if ( !params.isWhitespaceSensitive() ) options |= TextMatcher.IGNORE_WHITESPACES;
if ( !params.isPunctuationSensitive() ) options |= TextMatcher.IGNORE_PUNCTUATION;
triGramAnalyzer = new NgramAnalyzer(3);
df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ssZ");
df.setTimeZone(TimeZone.getTimeZone("GMT"));
return event;
}
@Override
protected Event handleEndBatch (Event event) {
matcher = null;
if ( writer != null ) {
writer.close();
writer = null;
}
if ( prnWriter != null ) {
prnWriter.close();
prnWriter = null;
}
if ( tmx != null ) {
tmx.writeEndDocument();
tmx.close();
tmx = null;
}
Runtime.getRuntime().gc();
if ( params.isAutoOpen() && ( pathToOpen != null )) {
Util.openURL((new File(pathToOpen)).getAbsolutePath());
}
return event;
}
@Override
protected Event handleStartDocument (Event event1) {
StartDocument startDoc1 = (StartDocument)event1.getResource();
initializeDocumentData();
isBaseMultilingual = startDoc1.isMultilingual();
// Move to start document for second input
Event event2 = synchronize(filter2, EventType.START_DOCUMENT);
StartDocument startDoc2 = (StartDocument)event2.getResource();
isInput2Multilingual = startDoc2.isMultilingual();
// Move to start document for third input
if ( filter3 != null ) {
Event event3 = synchronize(filter3, EventType.START_DOCUMENT);
StartDocument startDoc3 = (StartDocument)event3.getResource();
isInput3Multilingual = startDoc3.isMultilingual();
}
deScoreTotal1to2 = 0;
deScoreTotal1to3 = 0;
deScoreTotal2to3 = 0;
fmScoreTotal1to2 = 0;
fmScoreTotal1to3 = 0;
fmScoreTotal2to3 = 0;
wcTotal = 0;
edScoreWordTotal = 0;
fmScoreWordTotal = 0;
for ( int i=0; i 0 ) {
avgScore1to2 = (double)deScoreTotal1to2 / itemCount;
avgScore1to3 = (double)deScoreTotal1to3 / itemCount;
avgScore2to3 = (double)deScoreTotal2to3 / itemCount;
avgFuzzyScore1to2 = (double)fmScoreTotal1to2 / itemCount;
avgFuzzyScore1to3 = (double)fmScoreTotal1to3 / itemCount;
avgFuzzyScore2to3 = (double)fmScoreTotal2to3 / itemCount;
}
// Output report
if ( params.isGenerateHTML() ) {
writer.writeEndElement(); // table
writer.writeElementString("p", "");
if ( itemCount > 0 ) {
writer.writeStartElement("h2"); //$NON-NLS-1$
writer.writeAttributeString("id", "summary");
writer.writeString("Summary");
writer.writeEndElement();
// Matrix output
writer.writeElementString("p", String.format("Repartition for %s to %s:", params.getDocument1Label(), params.getDocument2Label()));
writer.writeRawXML(""); //$NON-NLS-1$
writer.writeRawXML("Scores ED-Scores FM-Scores "
+ "Segments "
+ "% "
+ "Words "
+ "% "
+ "Segments "
+ "% "
+ "Words "
+ "% "
+ " ");
printBracket(10, "100");
printBracket(9, "90 - 99");
printBracket(8, "80 - 89");
printBracket(7, "70 - 79");
printBracket(6, "60 - 69");
printBracket(5, "50 - 59");
printBracket(4, "40 - 49");
printBracket(3, "30 - 39");
printBracket(2, "20 - 29");
printBracket(1, "10 - 19");
printBracket(0, "0 - 9");
writer.writeRawXML("Total "); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", itemCount)); //$NON-NLS-1$
writer.writeRawXML("100% "); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", wcTotal)); //$NON-NLS-1$
writer.writeRawXML("100% "); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", itemCount)); //$NON-NLS-1$
writer.writeRawXML("100% "); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", wcTotal)); //$NON-NLS-1$
writer.writeRawXML("100% "); //$NON-NLS-1$
writer.writeRawXML("
\n"); // table
writer.writeElementString("p", " ");
writer.writeStartElement("table"); //$NON-NLS-1$
//--total number of segments--
writer.writeRawXML(""); //$NON-NLS-1$
writer.writeString("Total Number of Segments:"); //$NON-NLS-1$
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%d", itemCount));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Total Number of Words:"); //$NON-NLS-1$
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%d", wcTotal));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Average word count per segment:");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%.2f", (double)wcTotal / itemCount));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Average ED-Score (by segment):"); //$NON-NLS-1$
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%s to %s = %.2f",
params.getDocument1Label(), params.getDocument2Label(), avgScore1to2));
if ( deScoreTotal1to3 > 0 ) {
writer.writeString(String.format(", %s to %s = %.2f, ",
params.getDocument1Label(), params.getDocument3Label(), avgScore1to3));
writer.writeString(String.format("%s to %s = %.2f",
params.getDocument2Label(), params.getDocument3Label(), avgScore2to3));
}
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Average FM-Score (by segment):");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%s to %s = %.2f",
params.getDocument1Label(), params.getDocument2Label(), avgFuzzyScore1to2));
if ( deScoreTotal1to3 > 0 ) {
writer.writeString(String.format(", %s to %s = %.2f, ",
params.getDocument1Label(), params.getDocument3Label(), avgFuzzyScore1to3));
writer.writeString(String.format("%s to %s = %.2f",
params.getDocument2Label(), params.getDocument3Label(), avgFuzzyScore2to3));
}
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Average ED-Score (by word):");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%s to %s = %.2f",
params.getDocument1Label(), params.getDocument2Label(), edScoreWordTotalAvg));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Average FM-Score (by word):");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%s to %s = %.2f",
params.getDocument1Label(), params.getDocument2Label(), fmScoreWordTotalAvg));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("Edit Effort Score:");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%.2f", 100 - ((edScoreWordTotalAvg + fmScoreWordTotalAvg)/2)));
writer.writeRawXML(" baseDoc compDoc EDAvgScore FuzzyScore
out.printf("%s\t%s\t%s\t%.2f\t%.2f",
df.format(new Date()), baseDocumentPath, compDocumentPath, avgScore1to2, avgFuzzyScore1to2);
} catch ( IOException e ) {
logger.error("Cannot create the file '{}'\n{}", params.getDataLogPath(), e.getMessage());
}
}
return event;
}
private void printBracket (int index,
String range)
{
writer.writeRawXML(""+range+" "); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", edBrackets[index])); //$NON-NLS-1$
// ED-Scores
writer.writeRawXML(((itemCount == 0) ? "NA " : String.format("%.0f ", (double)edBrackets[index]/itemCount*100))); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", edWCBrackets[index])); //$NON-NLS-1$
writer.writeRawXML(((wcTotal == 0) ? "NA " : String.format("%.0f ", (double)edWCBrackets[index]/wcTotal*100))); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", fmBrackets[index])); //$NON-NLS-1$
// FM-Scores
writer.writeRawXML(((itemCount == 0) ? "NA " : String.format("%.0f ", (double)fmBrackets[index]/itemCount*100))); //$NON-NLS-1$
writer.writeRawXML(String.format("%d ", fmWCBrackets[index])); //$NON-NLS-1$
writer.writeRawXML(((wcTotal == 0) ? "NA " : String.format("%.0f ", (double)fmWCBrackets[index]/wcTotal*100))); //$NON-NLS-1$
writer.writeRawXML(""); //$NON-NLS-1$
// Output source if we have one
if ( srcFrag != null ) {
writer.writeString("Src:");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeRawXML(""); //$NON-NLS-1$
fmt.setContent(srcFrag);
writer.writeString(fmt.toString(!params.getGenericCodes()));
writer.writeRawXML(" "); //$NON-NLS-1$
}
writer.writeString(params.getDocument1Label()+":");
writer.writeRawXML(" "); //$NON-NLS-1$
if ( srcFrag != null ) writer.writeRawXML(""); //$NON-NLS-1$
else writer.writeRawXML(" "); //$NON-NLS-1$
fmt.setContent(trgFrag1);
writer.writeString(fmt.toString(!params.getGenericCodes()));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(params.getDocument2Label()+":");
writer.writeRawXML(" "); //$NON-NLS-1$
fmt.setContent(trgFrag2);
writer.writeString(fmt.toString(!params.getGenericCodes()));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(params.getDocument3Label()+":");
writer.writeRawXML(" "); //$NON-NLS-1$
fmt.setContent(trgFrag3);
writer.writeString(fmt.toString(!params.getGenericCodes()));
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("ED-Score:");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%s to %s = %d",
params.getDocument1Label(), params.getDocument2Label(), edScore1to2));
if ( edScore1to3 > -1 ) {
writer.writeString(String.format(", %s to %s = %d",
params.getDocument1Label(), params.getDocument3Label(), edScore1to3));
writer.writeString(String.format(", %s to %s = %d",
params.getDocument2Label(), params.getDocument3Label(), edScore2to3));
}
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString("FM-Score:");
writer.writeRawXML(" "); //$NON-NLS-1$
writer.writeString(String.format("%s to %s = %d",
params.getDocument1Label(), params.getDocument2Label(), fmScore1to2));
if ( edScore1to3 > -1 ) {
writer.writeString(String.format(", %s to %s = %d",
params.getDocument1Label(), params.getDocument3Label(), fmScore1to3));
writer.writeString(String.format(", %s to %s = %d",
params.getDocument2Label(), params.getDocument3Label(), fmScore2to3));
}
writer.writeRawXML(" Src Word Count: ");
writer.writeString(String.format("%d", srcWC));
writer.writeRawXML("
");
writer.writeString(String.format("Comparison 1 (%s): %s",
params.getDocument2Label(), compDocumentPath));
if ( rawDoc3 != null ) {
writer.writeRawXML("
");
writer.writeString(String.format("Comparison 2 (%s): %s",
params.getDocument3Label(), rawDoc3.getInputURI().getPath()));
}
writer.writeString(".");
writer.writeEndElement();
writer.writeRawXML("ED-Score = Edit distance score, FM-Score = Fuzzy Match score.
For details see: "
+""+WIKIURL+".
");
writer.writeRawXML("");
writer.writeStartElement("table"); //$NON-NLS-1$
// Starts file
// Open the tab-delimited log file
try {
prnWriter = new PrintWriter(
new BufferedWriter(
new OutputStreamWriter(
new FileOutputStream(getStatsFilename()),
StandardCharsets.UTF_8)));
}
catch ( Throwable e) {
logger.error("Cannot create the file '{}'\n{}", getStatsFilename(), e.getMessage());
}
prnWriter.println("ED-Score\tFM-Score\tWordCount");
}
}
private Event synchronize (IFilter filter,
EventType untilType)
{
boolean found = false;
Event event = null;
while ( !found && filter.hasNext() ) {
event = filter.next();
found = (event.getEventType() == untilType);
}
if ( !found ) {
throw new OkapiException("The document to compare is de-synchronized.");
}
return event;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy