com.ace.moab.api.node
Enum PriorityComponent

java.lang.Object
  java.lang.Enum<PriorityComponent>
      com.ace.moab.api.node.PriorityComponent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PriorityComponent>

public enum PriorityComponent
extends java.lang.Enum<PriorityComponent>

Represents the various options that can be used to create a NodePriorityFunction or FunctionExpression. This class also determines the value for the given component for any MoabNode input parameter.

Author:

Scott Brown.

Enum Constant Summary

ADISK

AMEM

APROCS

ASWAP

CDISK

CMEM

CPROCS

CSWAP

GMETRIC01

GMETRIC02

GMETRIC03

GMETRIC04

GMETRIC05

GMETRIC06

GMETRIC07

GMETRIC08

GMETRIC09

GMETRIC10

GMETRIC11

GMETRIC12

GMETRIC13

GMETRIC14

GMETRIC15

GMETRIC16

GMETRIC17

GMETRIC18

GMETRIC19

GMETRIC20

GMETRIC21

GMETRIC22

GMETRIC23

GMETRIC24

GMETRIC25

GMETRIC26

GMETRIC27

GMETRIC28

GMETRIC29

GMETRIC30

GMETRIC31

LOAD

PRIORITY

Method Summary

static java.util.Vector<java.lang.String>	getAvailableNames() Returns a vector of available priority attributes for a node priority function.
com.moab.api.node.NodeTableColumn	getColumn() Gets the corresponding column in the NodeTableColumn class.
java.lang.String	getMoabName() Gets the moab-parseable name of the attribute.
java.lang.String	getName() Gets the human-readable column name of the attribute.
java.lang.Object	getValue(MoabNode node) Gets the value for this priority component.
static PriorityComponent	parseName(java.lang.String name) Parses a string to a priority component attribute.
static PriorityComponent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PriorityComponent[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADISK

public static final PriorityComponent ADISK

AMEM

public static final PriorityComponent AMEM

APROCS

public static final PriorityComponent APROCS

ASWAP

public static final PriorityComponent ASWAP

CDISK

public static final PriorityComponent CDISK

CMEM

public static final PriorityComponent CMEM

CPROCS

public static final PriorityComponent CPROCS

CSWAP

public static final PriorityComponent CSWAP

GMETRIC01

public static final PriorityComponent GMETRIC01

GMETRIC02

public static final PriorityComponent GMETRIC02

GMETRIC03

public static final PriorityComponent GMETRIC03

GMETRIC04

public static final PriorityComponent GMETRIC04

GMETRIC05

public static final PriorityComponent GMETRIC05

GMETRIC06

public static final PriorityComponent GMETRIC06

GMETRIC07

public static final PriorityComponent GMETRIC07

GMETRIC08

public static final PriorityComponent GMETRIC08

GMETRIC09

public static final PriorityComponent GMETRIC09

GMETRIC10

public static final PriorityComponent GMETRIC10

GMETRIC11

public static final PriorityComponent GMETRIC11

GMETRIC12

public static final PriorityComponent GMETRIC12

GMETRIC13

public static final PriorityComponent GMETRIC13

GMETRIC14

public static final PriorityComponent GMETRIC14

GMETRIC15

public static final PriorityComponent GMETRIC15

GMETRIC16

public static final PriorityComponent GMETRIC16

GMETRIC17

public static final PriorityComponent GMETRIC17

GMETRIC18

public static final PriorityComponent GMETRIC18

GMETRIC19

public static final PriorityComponent GMETRIC19

GMETRIC20

public static final PriorityComponent GMETRIC20

GMETRIC21

public static final PriorityComponent GMETRIC21

GMETRIC22

public static final PriorityComponent GMETRIC22

GMETRIC23

public static final PriorityComponent GMETRIC23

GMETRIC24

public static final PriorityComponent GMETRIC24

GMETRIC25

public static final PriorityComponent GMETRIC25

GMETRIC26

public static final PriorityComponent GMETRIC26

GMETRIC27

public static final PriorityComponent GMETRIC27

GMETRIC28

public static final PriorityComponent GMETRIC28

GMETRIC29

public static final PriorityComponent GMETRIC29

GMETRIC30

public static final PriorityComponent GMETRIC30

GMETRIC31

public static final PriorityComponent GMETRIC31

LOAD

public static final PriorityComponent LOAD

PRIORITY

public static final PriorityComponent PRIORITY

Method Detail

values

public static final PriorityComponent[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PriorityComponent c : PriorityComponent.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static PriorityComponent valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getName

public java.lang.String getName()

Gets the human-readable column name of the attribute. This function uses the NodeTableColumn's column name attribute.

Returns:

The human-readable column name of the attribute.

getMoabName

public java.lang.String getMoabName()

Gets the moab-parseable name of the attribute. This function uses the Enum name of the attribute

Returns:

The moab-parseable column name of the attribute.

getAvailableNames

public static java.util.Vector<java.lang.String> getAvailableNames()

Returns a vector of available priority attributes for a node priority function.

Returns:

A vector of available priority attributes.

getValue

public java.lang.Object getValue(MoabNode node)

Gets the value for this priority component. The value could be a numerical number or any other object value. It's up to the caller to decide what to do with the response.

Parameters:

node - The node with the values

Returns:

The priority component's value for the input node.

getColumn

public com.moab.api.node.NodeTableColumn getColumn()

Gets the corresponding column in the NodeTableColumn class.

Returns:

The corresponding column in the NodeTableColumn class.

parseName

public static PriorityComponent parseName(java.lang.String name)
                                   throws java.text.ParseException

Parses a string to a priority component attribute. Uses either the human-readable name (from the NodeTableColumn columnName attribute) or parses the Moab name.

Parameters:

name - The name of the attribute in either human readable or Moab formats.

Returns:

A PriorityComponent based on the input name.

Throws:

java.text.ParseException - If no corresponding component is found, this exception is thrown.