org.cip4.jdflib.util.file.RollingDateFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDFLibJ Show documentation
CIP4 JDF Library for JDF 1.x
There is a newer version: 2.1.8.10
/**
 * The CIP4 Software License, Version 1.0
 *
 * Copyright (c) 2001-2024 The International Cooperation for the Integration of
 * Processes in  Prepress, Press and Postpress (CIP4).  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        The International Cooperation for the Integration of
 *        Processes in  Prepress, Press and Postpress (www.cip4.org)"
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "CIP4" and "The International Cooperation for the Integration of
 *    Processes in  Prepress, Press and Postpress" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact [email protected].
 *
 * 5. Products derived from this software may not be called "CIP4",
 *    nor may "CIP4" appear in their name, without prior written
 *    permission of the CIP4 organization
 *
 * Usage of this software in commercial products is subject to restrictions. For
 * details please consult [email protected].
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE INTERNATIONAL COOPERATION FOR
 * THE INTEGRATION OF PROCESSES IN PREPRESS, PRESS AND POSTPRESS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the The International Cooperation for the Integration
 * of Processes in Prepress, Press and Postpress and was
 * originally based on software
 * copyright (c) 1999-2001, Heidelberger Druckmaschinen AG
 * copyright (c) 1999-2001, Agfa-Gevaert N.V.
 *
 * For more information on The International Cooperation for the
 * Integration of Processes in  Prepress, Press and Postpress , please see
 * .
 *
 *
 */
package org.cip4.jdflib.util.file;

import java.io.File;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.cip4.jdflib.util.FileUtil;
import org.cip4.jdflib.util.JDFDate;
import org.cip4.jdflib.util.StringUtil;

/**
 * File that gets a new file whenever time and date changes
 * 
 * @author rainer prosi
 * @date Mar 18, 2012
 */
public class RollingDateFile extends RollingFile
{
	FileJanitor janitor;
	private static final Log log = LogFactory.getLog(RollingDateFile.class);

	public FileJanitor getJanitor()
	{
		return janitor;
	}

	public void setJanitor(final long seconds)
	{
		janitor = new FileJanitor(this, seconds);
	}

	/**
	 *
	 */
	private static final long serialVersionUID = 1L;
	/**
	 *
	 */
	public static final String MM = "yyMM";
	/**
	 *
	 */
	public static final String DD = MM + "dd";
	/**
	 *
	 */
	public static final String DDHH = DD + "HH";
	private String format;

	/**
	 * @param pathname
	 * @param baseName
	 */
	public RollingDateFile(final String pathname, final String baseName)
	{
		super(pathname, baseName);
		format = DD;
		janitor = null;
	}

	@Override
	protected String getNewFileName()
	{
		return getNewFileName(System.currentTimeMillis());
	}

	protected String getNewFileName(final long t)
	{
		final String exp = getFileExpression();
		final JDFDate d = new JDFDate(t);
		final String date = "." + d.getFormattedDateTime(format);
		return StringUtil.replaceString(exp, "(.)*", date);
	}

	/**
	 * @see org.cip4.jdflib.util.file.RollingFile#calcPos()
	 */
	@Override
	protected int calcPos()
	{
		return 0;
	}

	/**
	 * Getter for format attribute.
	 * 
	 * @return the format
	 */
	public String getFormat()
	{
		return format;
	}

	/**
	 * Setter for format attribute used to format the file names
	 * 
	 * @param format the format to set
	 */
	public void setFormat(final String format)
	{
		this.format = format;
	}

	/**
	 * @param t the time in milliseconds that applies to this file
	 * @return the file to write, null if error occurred
	 */
	public File getNewFile(final long t)
	{
		File file = new File(this, getNewFileName(t));
		if (!file.exists())
		{
			final boolean bSnafu = !FileUtil.createNewFile(file);
			if (bSnafu)
			{
				log.error("cannot create file: " + file.getAbsolutePath());
				file = null;
			}
			else
			{
				init(file);
			}
		}
		return file;
	}

	/**
	 * initialization routine for a new file
	 * 
	 * @param file
	 */
	public void init(final File file)
	{
		if (janitor != null)
			janitor.cleanup();

	}

}