com.conversantmedia.mapreduce.tool.annotation.NamedOutput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mara-annotations Show documentation

Mara - Java Annotations Framework for MapReduce on Hadoop

There is a newer version: 0.9.6

package com.conversantmedia.mapreduce.tool.annotation;

/*
 * #%L
 * Mara Annotations/API
 * ~~
 * Copyright (C) 2015 Conversant
 * ~~
 * 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.
 * #L%
 */


import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apache.hadoop.mapreduce.OutputFormat;
import org.apache.hadoop.mapreduce.lib.output.TextOutputFormat;

@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NamedOutput {

	/**
	 * Sets the name when you don't need any other
	 * options. Enables writing @NamedOutput("myMulitOutName")
	 * Supports OGNL expressions by enclosing expression in braces, prefixed
	 * by a '$'. Example: @NamedOutput("${context.property}")
	 * @return	a name for this output.
	 */
	String[] value() default "default";

	/**
	 * Sets the name. Synonymous with value - designed primarily for use
	 * when you're setting multiple options and don't want to use 'value=""'
	 * Supports OGNL expressions by enclosing expression in braces, prefixed
	 * by a '$'.
	 * @return	a name for this output
	 */
	String[] name() default "default";

	/**
	 * Key/value type to output.
	 * @return	the key/value type for this output
	 */
	KeyValue type() default @KeyValue;

	/**
	 * Output format class.
	 * @return	the output format to use
	 */
	@SuppressWarnings("rawtypes")
	Class format() default TextOutputFormat.class;

	/**
	 * MultipleOutputs.setCountersEnabled(boolean)
	 * @return	determines if counters should be enabled
	 */
	boolean countersEnabled() default false;

}