DisplayerPropertyFileGenerator.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.app.util;

import java.lang.reflect.Type;
import java.util.Map;
import java.util.TreeMap;

import org.jhove2.core.JHOVE2Exception;
import org.jhove2.core.reportable.info.ReportablePropertyInfo;
import org.jhove2.module.display.AbstractDisplayer;

/**
 * Class to generate editable Java properties file for Displayer settings for
 * {@link org.jhove2.core.reportable.Reportable} features
 * @author smorrissey
 *
 */
public class DisplayerPropertyFileGenerator extends PropertyFileGenerator {

	/**
	 * Header for top of file
	 */
	public static final String DISPLAY_HEADER = 
		 "# _displayer.properties\n" +
         "# The visibility directives control the display of the properties identified by URI\n" +
         "# The directives can be: Always, IfFalse, IfNegative, IfNonNegative, IfNonPositive,\n" +
         "#                        IfNonZero, IfPositive, IfTrue, IfZero, Never\n" +
         "# A property is not displayed if its value is not consistent with the directive.\n" +
         "# Negative means ...,-2,-1; NonNegative means 0,1,2...\n" +
         "# Positive means 1,2,3,...; NonPositive means ...,-2,-1,0";
    /**
     * Convention for naming file is {CLASSNAME}_displayer.properties
     */
	public static final String PROP_BASE_NAME = "_displayer";
	/** Usage string */
	public static final String USAGE = 
		"USAGE:  java -cp CLASSPATH" + DisplayerPropertyFileGenerator.class.getName() + " fully-qualified-class-name output-dir-path";
	/** Error return code for erroneous command line invocation */
	public static final int EUSAGE = 1;
	/** Error return code if any exception is thrown while executing program */
	public static final int EEXCEPTION = 2;
	/** Return code for successful execution */
	public static final int SUCCESS = 0;
	
	/**
	 * Constructor
	 */
	public DisplayerPropertyFileGenerator() {
		super();
		this.setHeaderInfo(DISPLAY_HEADER);
		this.setPropertyFileBaseName(PROP_BASE_NAME);
	}

	@Override
	public  Map<String, String> createPropertyValues(){
		Map<String, String> map = new TreeMap<String, String>();
		for (ReportablePropertyInfo info : this.getPropsList()){
			String value = getDisplayChoices(info);
			String mapKey = info.getIdentifier().getValue();
			map.put(mapKey, value);
		}
		return map;
	}
	/**
	 * Main method invoked to generate Displayer properties files.
	 * @param args 2 arguments:  fully qualified class name for Reportable class for which
	 * property file is to be generated, and directory path to which file should be written
	 * File with be written to base-path plus sub-directories corresponding to class's package
	 * name, and file will have name baseclassname_displayer.properties
	 */
	public static void main(String[] args) {
		if (args.length < 2){
			System.out.println(USAGE);
			System.exit(EUSAGE);
		}
		DisplayerPropertyFileGenerator dpg = new DisplayerPropertyFileGenerator();
		dpg.setClassName(args[0]);
		dpg.setBaseOutputDirectory(args[1]);
		dpg.setIncludeAncestors(false);
		try{
			dpg.createPropertyFile();
			System.out.println("Succesfully created displayer property file for class " + dpg.getClassName());
			System.out.println("File can be found at " + dpg.getFullFilePath());
			System.exit(SUCCESS);
		}
		catch (Exception e){
			System.out.println("Exception thrown attempting to create a file for class "
					 + dpg.getClassName() + " in directory " + dpg.getBaseOutputDirectory());
			System.out.println(e.getMessage());
			e.printStackTrace(); 
			System.exit(EEXCEPTION);
		}
	}

	/**
	 * Get list of possible display choices for a property
	 * @param {@link org.jhove2.core.reportable.info.ReportablePropertyInfo} for a Reportable property
	 * @return String with possible display choices for a property
	 * @throws JHOVE2Exception 
	 */
	public static String getDisplayChoices(ReportablePropertyInfo info){
		StringBuffer choices = new StringBuffer(DisplayerPropertyFileGenerator.getAllTypesDisplayChoices());
		Type type = info.getGenericType();
		if (FeatureConfigurationUtil.isBooleanType(type)){
			choices.append(FeatureConfigurationUtil.OR);
			choices.append(DisplayerPropertyFileGenerator.getBooleanDisplayChoices());
		}
		else if (FeatureConfigurationUtil.isNumericType(type)){
			choices.append(FeatureConfigurationUtil.OR);
			choices.append(DisplayerPropertyFileGenerator.getNumericDisplayChoices());
		}
		return choices.toString();
	}

	/**
	 * Get display choices available to properties of all types
	 * @return String containing choices available to properties of all types
	 */
	public static String getAllTypesDisplayChoices(){
		StringBuffer choices = new StringBuffer(
				AbstractDisplayer.DisplayVisibility.Always.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.Never.toString());
		return choices.toString();
	}

	/**
	 * Get display choices available to boolean properties
	 * @return String containing choices available to boolean properties
	 */
	public static String getBooleanDisplayChoices(){
		StringBuffer choices = new StringBuffer(
				AbstractDisplayer.DisplayVisibility.IfTrue.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.IfFalse.toString());
		return choices.toString();
	}

	/**
	 * Get display choices available to boolean properties
	 * @return String containing choices available to boolean properties
	 */
	public static String getNumericDisplayChoices(){
		StringBuffer choices = new StringBuffer(
				AbstractDisplayer.DisplayVisibility.IfNegative.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.IfNonNegative.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.IfNonPositive.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.IfNonZero.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.IfPositive.toString());
		choices.append(FeatureConfigurationUtil.OR);
		choices.append(
				AbstractDisplayer.DisplayVisibility.IfZero.toString());
		return choices.toString();
	}

}