cascading.property
Class AppProps

java.lang.Object
  extended by cascading.property.Props
      extended by cascading.property.AppProps

public class AppProps
extends Props

Class AppPros is a fluent helper for setting various application level properties that every Flow may or may not be required to have set. These properties are typically passed to a Flow via a FlowConnector.

In prior releases, the FlowConnector was responsible for setting the "application jar" class or path. Those methods have been deprecated and moved to AppConfig.

New property settings that may be set in Cascading 2 are application name, version, and any tags.


Field Summary
static java.lang.String APP_ID
           
static java.lang.String APP_JAR_CLASS
           
static java.lang.String APP_JAR_PATH
           
static java.lang.String APP_NAME
           
static java.lang.String APP_TAGS
           
static java.lang.String APP_VERSION
           
protected  java.lang.String name
           
protected  java.util.Set<java.lang.String> tags
           
protected  java.lang.String version
           
 
Constructor Summary
AppProps()
           
AppProps(java.lang.String name, java.lang.String version)
           
 
Method Summary
static void addApplicationTag(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String tag)
           
protected  void addPropertiesTo(java.util.Properties properties)
           
 AppProps addTag(java.lang.String tag)
           
 AppProps addTags(java.lang.String... tags)
           
static AppProps appProps()
           
static java.lang.String getApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties)
           
static java.lang.Class getApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties)
          Method getApplicationJarClass returns the Class set by the setApplicationJarClass method.
static java.lang.String getApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties)
          Method getApplicationJarPath return the path set by the setApplicationJarPath method.
static java.lang.String getApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties)
           
static java.lang.String getApplicationTags(java.util.Map<java.lang.Object,java.lang.Object> properties)
           
static java.lang.String getApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties)
           
 java.lang.String getTags()
           
static void resetAppID()
          Sets the static appID value to null.
static void setApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties)
           
static void setApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.Class type)
          Method setApplicationJarClass is used to set the application jar file.
static void setApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String path)
          Method setApplicationJarPath is used to set the application jar file.
static void setApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String name)
           
static void setApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String version)
           
 AppProps setName(java.lang.String name)
           
 AppProps setVersion(java.lang.String version)
           
 
Methods inherited from class cascading.property.Props
buildProperties, buildProperties, buildProperties, setProperties, setProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APP_ID

public static final java.lang.String APP_ID
See Also:
Constant Field Values

APP_NAME

public static final java.lang.String APP_NAME
See Also:
Constant Field Values

APP_VERSION

public static final java.lang.String APP_VERSION
See Also:
Constant Field Values

APP_TAGS

public static final java.lang.String APP_TAGS
See Also:
Constant Field Values

APP_JAR_CLASS

public static final java.lang.String APP_JAR_CLASS
See Also:
Constant Field Values

APP_JAR_PATH

public static final java.lang.String APP_JAR_PATH
See Also:
Constant Field Values

name

protected java.lang.String name

version

protected java.lang.String version

tags

protected java.util.Set<java.lang.String> tags
Constructor Detail

AppProps

public AppProps()

AppProps

public AppProps(java.lang.String name,
                java.lang.String version)
Method Detail

appProps

public static AppProps appProps()

setApplicationJarClass

public static void setApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties,
                                          java.lang.Class type)
Method setApplicationJarClass is used to set the application jar file.

All cluster executed Cascading applications need to call setApplicationJarClass(java.util.Map, Class) or setApplicationJarPath(java.util.Map, String), otherwise ClassNotFound exceptions are likely.

Parameters:
properties - of type Map
type - of type Class

getApplicationJarClass

public static java.lang.Class getApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties)
Method getApplicationJarClass returns the Class set by the setApplicationJarClass method.

Parameters:
properties - of type Map
Returns:
Class

setApplicationJarPath

public static void setApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties,
                                         java.lang.String path)
Method setApplicationJarPath is used to set the application jar file.

All cluster executed Cascading applications need to call setApplicationJarClass(java.util.Map, Class) or setApplicationJarPath(java.util.Map, String), otherwise ClassNotFound exceptions are likely.

Parameters:
properties - of type Map
path - of type String

getApplicationJarPath

public static java.lang.String getApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties)
Method getApplicationJarPath return the path set by the setApplicationJarPath method.

Parameters:
properties - of type Map
Returns:
String

setApplicationID

public static void setApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties)

getApplicationID

public static java.lang.String getApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties)

resetAppID

public static void resetAppID()
Sets the static appID value to null. For debugging purposes.


setApplicationName

public static void setApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties,
                                      java.lang.String name)

getApplicationName

public static java.lang.String getApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties)

setApplicationVersion

public static void setApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties,
                                         java.lang.String version)

getApplicationVersion

public static java.lang.String getApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties)

addApplicationTag

public static void addApplicationTag(java.util.Map<java.lang.Object,java.lang.Object> properties,
                                     java.lang.String tag)

getApplicationTags

public static java.lang.String getApplicationTags(java.util.Map<java.lang.Object,java.lang.Object> properties)

setName

public AppProps setName(java.lang.String name)

setVersion

public AppProps setVersion(java.lang.String version)

getTags

public java.lang.String getTags()

addTag

public AppProps addTag(java.lang.String tag)

addTags

public AppProps addTags(java.lang.String... tags)

addPropertiesTo

protected void addPropertiesTo(java.util.Properties properties)
Specified by:
addPropertiesTo in class Props


Copyright © 2007-2011 Concurrent, Inc. All Rights Reserved.