TiffDLFProfile.java

/**
 * JHOVE2 - Next-generation architecture for format-aware characterization
 * 
 * Copyright (c) 2009 by The Regents of the University of California, Ithaka
 * Harbors, Inc., and The Board of Trustees of the Leland Stanford Junior
 * University. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * o Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * 
 * o 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.
 * 
 * o Neither the name of the University of California/California Digital
 * Library, Ithaka Harbors/Portico, or Stanford University, nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
 */
package org.jhove2.module.format.tiff.profile;

import org.jhove2.annotation.ReportableProperty;
import org.jhove2.core.JHOVE2;
import org.jhove2.core.JHOVE2Exception;
import org.jhove2.core.Message;
import org.jhove2.core.Message.Context;
import org.jhove2.core.Message.Severity;
import org.jhove2.core.format.Format;
import org.jhove2.module.format.tiff.TiffIFD;
import org.jhove2.module.format.tiff.type.Rational;
import org.jhove2.persist.FormatProfileAccessor;

import com.sleepycat.persist.model.Persistent;

/**
 * @author MStrong
 * 
 */
@Persistent
public class TiffDLFProfile extends TiffProfile {

    /** Profile version identifier. */
    public static final String VERSION = "2.0.0";

    /** Profile release date. */
    public static final String RELEASE = "2010-09-10";

    /** Profile rights statement. */
    public static final String RIGHTS = "Copyright 2010 by The Regents of the University of California. "
            + "Available under the terms of the BSD license.";

    /** Profile validation coverage. */
    public static final Coverage COVERAGE = Coverage.Inclusive;

    /** minimum resolution value invalid message */
    protected Message minimumResolutionValueInvalidMessage;
    
    /**
     * 
     * @param format
     * @param formatProfileAccessor
     */
    public TiffDLFProfile(Format format, FormatProfileAccessor formatProfileAccessor) {
        super(format, formatProfileAccessor);
    }
    
    @SuppressWarnings("unused")
	private TiffDLFProfile(){
    	this(null,null);
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.jhove2.module.format.tiff.profile.TiffProfile#validateThisProfile()
     */
    @Override
    public void validateThisProfile(JHOVE2 jhove2, TiffIFD ifd)
            throws JHOVE2Exception {

        /* Check required values. */

        if (!isPhotometricInterpretationValid(ifd, new int[] { 0, 1 })) {
            this.isValid = Validity.False;
            this.invalidPhotometricInterpretationValueMessage = new Message(
                    Severity.WARNING,
                    Context.OBJECT,
                    "org.jhove2.module.format.tiff.profile.TIFFProfile.InvalidPhotometricInterpretationValueMessage",
                    jhove2.getConfigInfo());
        }
    }

    /**
     * Checks for minimum X and Y resolution. All of the DLF profiles have
     * similar tests for XResolution and YResolution. In all cases the values
     * depend on the ResolutionUnit, which must be either 2 or 3.
     * 
     * @param tifd
     *            The TiffIFD from which to extract the tags.
     * @param minUnit2Res
     *            The minimum XResolution and YResolution when ResolutionUnit is
     *            2
     * @param minUnit3Res
     *            The minimum XResolution and YResolution when ResolutionUnit is
     *            3
     */

    protected boolean hasMinimumResolution(TiffIFD ifd, double minUnit2Res,
            double minUnit3Res) {
        if (!ifd.hasXResolution() || !ifd.hasYResolution()) {
            return false;
        }

        Rational XResolution = (Rational) ifd.getEntries().get(
                TiffIFD.XRESOLUTION).getValue();
        Rational YResolution = (Rational) ifd.getEntries().get(
                TiffIFD.YRESOLUTION).getValue();

        int resUnit = ifd.getResolutionUnit();
        if (resUnit == 2) {
            if (XResolution.toDouble() < minUnit2Res
                    || YResolution.toDouble() < minUnit2Res) {
                return false;
            }
        }
        else if (resUnit == 3) {
            if (XResolution.toDouble() < minUnit3Res
                    || YResolution.toDouble() < minUnit3Res) {
                return false;
            }
        }
        else {
            return false; // resUnit must be 2 or 3
        }
        return true; // passed all tests
    }

    /**
     * @return the minimumResolutionValueInvalidMessage
     */
    @ReportableProperty(order = 1, value = "Minimum Resolution value message.")
    public Message getMinimumResolutionValueInvalidMessage() {
        return minimumResolutionValueInvalidMessage;
    }
}