de.tudarmstadt.ukp.wikipedia.timemachine.domain.TimeMachineFiles Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of de.tudarmstadt.ukp.wikipedia.timemachine Show documentation
The newest version!
/*******************************************************************************
 * Copyright 2015
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 *
 * 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 de.tudarmstadt.ukp.wikipedia.timemachine.domain;

import java.io.File;
import java.sql.Timestamp;

import de.tudarmstadt.ukp.wikipedia.wikimachine.debug.ILogger;
import de.tudarmstadt.ukp.wikipedia.wikimachine.domain.Files;
import de.tudarmstadt.ukp.wikipedia.wikimachine.util.TimestampUtil;

public class TimeMachineFiles extends Files {

	private static final String NO_CATEGORYLINKS = "category links file not found";
	private static final String NO_METAHISTORY = "meta history file not found";
	private static final String NO_PAGELINKS = "page links file not found";

	private String metaHistoryFile;
	private String pageLinksFile;
	private String categoryLinksFile;
	private String timeStamp = "";

	public TimeMachineFiles(ILogger logger) {
		super(logger);
	}

	public TimeMachineFiles(TimeMachineFiles files) {
		super(files);
		this.metaHistoryFile = files.metaHistoryFile;
		this.pageLinksFile = files.metaHistoryFile;
		this.categoryLinksFile = files.categoryLinksFile;
	}

	/**
	 * Add a sub directory called "timestamp" to the current output directory
	 * 
	 * @param timestamp
	 *            - name of a new sub directory
	 */
	public void setTimestamp(Timestamp timestamp) {

		timeStamp = TimestampUtil.toMediaWikiString(timestamp) + File.separator;
	}

	public String getMetaHistoryFile() {
		return metaHistoryFile;
	}

	public void setMetaHistoryFile(String metaHistroyFile) {
		this.metaHistoryFile = metaHistroyFile;
	}

	public String getPageLinksFile() {
		return pageLinksFile;
	}

	public void setPageLinksFile(String pageLinksFile) {
		this.pageLinksFile = pageLinksFile;
	}

	public String getCategoryLinksFile() {
		return categoryLinksFile;
	}

	public void setCategoryLinksFile(String categoryLinksFile) {
		this.categoryLinksFile = categoryLinksFile;
	}

	public boolean checkInputFile(String fileName, String errorMessage) {
		File inputFile = new File(fileName);
		boolean result = inputFile.exists() && inputFile.canRead();
		if (!result) {
			logger.log(errorMessage);
		}
		return result;
	}

	@Override
	protected String getOutputPath(String fileName) {
		File outputSubDirectory = new File(outputDirectory.getAbsolutePath()
				+ File.separator + timeStamp);
		outputSubDirectory.mkdir();
		return outputDirectory.getAbsolutePath() + File.separator + timeStamp
				+ fileName;
	}

	@Override
	public boolean checkAll() {
		return checkOutputDirectory()
				&& checkInputFile(metaHistoryFile, NO_METAHISTORY)
				&& checkInputFile(pageLinksFile, NO_PAGELINKS)
				&& checkInputFile(categoryLinksFile, NO_CATEGORYLINKS);
	}
}