net.sf.okapi.steps.diffleverage.FileAlignment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okapi-lib Show documentation

There is a newer version: 1.47.0

package net.sf.okapi.steps.diffleverage;

/**
 * Stores alignments of {@link FileLikeThing}s
 * 
 * @author HargraveJE
 * 
 * @param 
 */
public class FileAlignment {
	// new src file or src in bi-lingual case
	private FileLikeThing newFile;
	private FileLikeThing trgFile;

	private FileLikeThing oldSrcFile;
	// optional target file aligned with old source
	private FileLikeThing oldTrgFile;

	/**
	 * Bi-lingual alignment
	 * 
	 * @param newFile
	 *            source file
	 * @param trgFile
	 *            target file
	 */
	public FileAlignment(FileLikeThing newFile, FileLikeThing trgFile) {
		this.newFile = newFile;
		this.trgFile = trgFile;
	}

	/**
	 * Tri-lingual alignment
	 * 
	 * @param newFile
	 *            new source file
	 * @param oldSrcFile
	 *            old source file
	 * @param oldTrgFile
	 *            old target file
	 */
	public FileAlignment(FileLikeThing newFile, FileLikeThing oldSrcFile,
			FileLikeThing oldTrgFile) {
		this.newFile = newFile;
		this.oldSrcFile = oldSrcFile;
		this.oldTrgFile = oldTrgFile;
	}

	/**
	 * Create a 1-0 alignment (source only)
	 * 
	 * @param newFile
	 *            new source file
	 */
	public FileAlignment(FileLikeThing newFile) {
		this.newFile = newFile;
	}

	/**
	 * Get the new source {@link FileLikeThing}
	 * 
	 * @return new source {@link FileLikeThing}
	 */
	public FileLikeThing getNew() {
		return newFile;
	}

	/**
	 * Get the old source {@link FileLikeThing} (matches the new source)
	 * 
	 * @return old source {@link FileLikeThing}
	 */
	public FileLikeThing getOldSrc() {
		return oldSrcFile;
	}

	/**
	 * Get old target {@link FileLikeThing}
	 * 
	 * @return old target {@link FileLikeThing} (matches old source)
	 */
	public FileLikeThing getOldTrg() {
		return oldTrgFile;
	}

	/**
	 * Get target {@link FileLikeThing} (matches "new" source file)
	 * 
	 * @return the trgFile
	 */
	public FileLikeThing getTrgFile() {
		return trgFile;
	}
}