umich.cac.data
Class FieldName

java.lang.Object
  extended byumich.cac.data.FieldName

public class FieldName
extends java.lang.Object

FieldName class This class encapsulates the display name (the name given to the XML tag) and raw name (the name PBS used to encode the data) to a field.

For example, PBS encodes the exit status of a job with the name "Exit_status", this is the raw name. We display in the XML the name "exit_status", which is the display name for this raw field.

Version:
$Header: /cvsroot/pbsaccounting/pbsaccounting/doc/javadoc/umich/cac/data/FieldName.html,v 1.6 2003/10/21 20:33:47 rodmach Exp $
Author:
rmach@umich.edu

Field Summary
static FieldName ABORT_FIELD
          Abort Field
static FieldName ACCOUNT
          Used for optional account parameter for charging job to specific account
static FieldName AUTHORIZED_USERS
          Authorized users is for BRecord, PBS Pro specific on linux
static FieldName B_FIELD
          BField.
static FieldName BNODES
          The list of nodes, for a BRecord PBS Pro specific on linux
static FieldName CHECKPOINT_RESTART_FIELD
          Checkpoint restart Field
static FieldName CPU
          CPU is the cpu number the job ran on, not defined in PBS, it is extracted from nodename
static FieldName CPU_PERCENT
          Origin Specific.
static FieldName CPU_USED
          Added by PBSPro on Linux.
static FieldName CPUT
          Origin Specific.
static FieldName CPUTIME
          The cpu time used
static FieldName CTIME
          The ctime of the job, the time in seconds when the job was created (first submitted)
static FieldName DATE
          Date, part of base record
static FieldName DAY
          The day of the record, as in 10/12/2002, not defined in PBS, it is extracted from Date
static FieldName DELETE_FIELD
          Delete Field
static FieldName DURATION
          Duration, specific to BField.
static FieldName END
          The end of the job
static FieldName ETIME
          The etime of the job, the time in seconds when the job became eligible to run, no holds etc
static FieldName EXEC_HOST
          The execution host(s) ran on
static FieldName EXECUTION_FIELD
          Execution Field
static FieldName EXIT_STATUS
          Exit status of job
static FieldName GROUP
          The group name under which the job executed
static FieldName INTERACTIVE_FIELD
          InteractiveField.
static FieldName JOBID
          Job Id, part of base
static FieldName JOBNAME
          The name of the job as chosen by the user
static FieldName K_FIELD
          KField.
static FieldName MEM
          The memory used
static FieldName MEMORY
          The memory of the job
static FieldName MEMORY_R
          The memory requested
static FieldName NAME
          Name of user running job
static FieldName NEED_NODES
          A list of nodes assigned to job
static FieldName NODE
          A node.
static FieldName NODECT
          The node count requested
static FieldName NODENAME
          Nodename lists node resources job ran on
static FieldName NODES
          The number of nodes requested
static FieldName NUMCPUS
          Origin Specific.
static FieldName OWNER
          Owner, specific to BField.
static FieldName QTIME
          The qtime of the job, the time in seconds when the job was queued into the current queue
static FieldName QUEUE
          The name of the queue from which the job was executed
static FieldName QUEUE_FIELD
          Wait field
static FieldName REQUESTOR
          The requester for a job cancellation
static FieldName RERUN_FIELD
          Rerun Field
static FieldName RESOURCE_LIST
          Container field
static FieldName RESOURCE_USED
          Container field
static FieldName SESSION
          The session number of the job
static FieldName START
          The start of the job, the time in seconds when job execution started
static FieldName START_FIELD
          Start Field
static FieldName TIME
          The time of the record, as in 10:11:11, not defined in PBS, it is extracted from Date
static FieldName U_FIELD
          UField.
static FieldName UNITS
          The memory units of the job
static FieldName USER
          container of user running job, not defined in PBS
static FieldName VMEM
          The virtual memory used
static FieldName WALLTIME
          The wall time used
static FieldName WALLTIME_R
          The wall time requested
static FieldName Y_FIELD
          YField.
 
Constructor Summary
FieldName(java.lang.String displayName, java.lang.String rawName, FieldType fieldType)
          Constructor
 
Method Summary
 java.lang.String closeTag()
          Get the closed tag name for this field
static FieldName[] getAllFieldNames()
          get all fields
 java.lang.String getDisplayName()
          Get the display name, which is the name that is used for the XML tag, like display name for Resource_List.nodect is nodect
 FieldType getFieldType()
          Gets the fieldType attribute of the FieldName object
 java.lang.String getRawName()
          Get the "raw" name, which is the original encoded name in the PBS file, like Resource_List.nodect
 java.lang.String openTag()
          Get the open tag name for this field
 java.lang.String openTag(java.util.List attributeList)
          Get the open tag name for this field including the attributes named by the List of Attribute objects passed to this method
 boolean rawequals(FieldName fieldName)
          Compare two FieldName's objects for equality based on their raw fields
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

QUEUE

public static final FieldName QUEUE
The name of the queue from which the job was executed


NODE

public static final FieldName NODE
A node. The raw name for this field is not defined in PBS, and is used for container of node information


GROUP

public static final FieldName GROUP
The group name under which the job executed


JOBNAME

public static final FieldName JOBNAME
The name of the job as chosen by the user


CTIME

public static final FieldName CTIME
The ctime of the job, the time in seconds when the job was created (first submitted)


QTIME

public static final FieldName QTIME
The qtime of the job, the time in seconds when the job was queued into the current queue


ETIME

public static final FieldName ETIME
The etime of the job, the time in seconds when the job became eligible to run, no holds etc


START

public static final FieldName START
The start of the job, the time in seconds when job execution started


MEMORY

public static final FieldName MEMORY
The memory of the job


UNITS

public static final FieldName UNITS
The memory units of the job


SESSION

public static final FieldName SESSION
The session number of the job


END

public static final FieldName END
The end of the job


EXIT_STATUS

public static final FieldName EXIT_STATUS
Exit status of job


USER

public static final FieldName USER
container of user running job, not defined in PBS


NAME

public static final FieldName NAME
Name of user running job


DATE

public static final FieldName DATE
Date, part of base record


DAY

public static final FieldName DAY
The day of the record, as in 10/12/2002, not defined in PBS, it is extracted from Date


TIME

public static final FieldName TIME
The time of the record, as in 10:11:11, not defined in PBS, it is extracted from Date


JOBID

public static final FieldName JOBID
Job Id, part of base


NODENAME

public static final FieldName NODENAME
Nodename lists node resources job ran on


CPU

public static final FieldName CPU
CPU is the cpu number the job ran on, not defined in PBS, it is extracted from nodename


REQUESTOR

public static final FieldName REQUESTOR
The requester for a job cancellation


NEED_NODES

public static final FieldName NEED_NODES
A list of nodes assigned to job


NODECT

public static final FieldName NODECT
The node count requested


NODES

public static final FieldName NODES
The number of nodes requested


WALLTIME_R

public static final FieldName WALLTIME_R
The wall time requested


MEMORY_R

public static final FieldName MEMORY_R
The memory requested


CPUTIME

public static final FieldName CPUTIME
The cpu time used


MEM

public static final FieldName MEM
The memory used


WALLTIME

public static final FieldName WALLTIME
The wall time used


VMEM

public static final FieldName VMEM
The virtual memory used


EXEC_HOST

public static final FieldName EXEC_HOST
The execution host(s) ran on


RESOURCE_LIST

public static final FieldName RESOURCE_LIST
Container field


RESOURCE_USED

public static final FieldName RESOURCE_USED
Container field


EXECUTION_FIELD

public static final FieldName EXECUTION_FIELD
Execution Field


QUEUE_FIELD

public static final FieldName QUEUE_FIELD
Wait field


START_FIELD

public static final FieldName START_FIELD
Start Field


DELETE_FIELD

public static final FieldName DELETE_FIELD
Delete Field


RERUN_FIELD

public static final FieldName RERUN_FIELD
Rerun Field


CHECKPOINT_RESTART_FIELD

public static final FieldName CHECKPOINT_RESTART_FIELD
Checkpoint restart Field


ABORT_FIELD

public static final FieldName ABORT_FIELD
Abort Field


NUMCPUS

public static final FieldName NUMCPUS
Origin Specific. The number of CPUS requested


CPUT

public static final FieldName CPUT
Origin Specific. The CPU time requested


CPU_PERCENT

public static final FieldName CPU_PERCENT
Origin Specific. The percentage of CPU time used


CPU_USED

public static final FieldName CPU_USED
Added by PBSPro on Linux. The Number of CPU's actually used


K_FIELD

public static final FieldName K_FIELD
KField. PBS Pro specific on Linux


U_FIELD

public static final FieldName U_FIELD
UField. PBS Pro specific on Linux


Y_FIELD

public static final FieldName Y_FIELD
YField. PBS Pro specific on Linux


B_FIELD

public static final FieldName B_FIELD
BField. PBS Pro specific on Linux


OWNER

public static final FieldName OWNER
Owner, specific to BField. PBS Pro specific on Linux


DURATION

public static final FieldName DURATION
Duration, specific to BField. PBS Pro specific on Linux


INTERACTIVE_FIELD

public static final FieldName INTERACTIVE_FIELD
InteractiveField. PBS Pro specific on Linux


BNODES

public static final FieldName BNODES
The list of nodes, for a BRecord PBS Pro specific on linux


AUTHORIZED_USERS

public static final FieldName AUTHORIZED_USERS
Authorized users is for BRecord, PBS Pro specific on linux


ACCOUNT

public static final FieldName ACCOUNT
Used for optional account parameter for charging job to specific account

Constructor Detail

FieldName

public FieldName(java.lang.String displayName,
                 java.lang.String rawName,
                 FieldType fieldType)
Constructor

Parameters:
displayName - the name that will appear in XML tag, like "exec_host"
rawName - the name that PBS uses to describe the field, like "Exec_Host"
fieldType - Description of the Parameter
Method Detail

rawequals

public boolean rawequals(FieldName fieldName)
Compare two FieldName's objects for equality based on their raw fields

Parameters:
fieldName - The field to compare to
Returns:
true if the raw values are the same

getAllFieldNames

public static FieldName[] getAllFieldNames()
get all fields

Returns:
The allFieldNames value

getFieldType

public FieldType getFieldType()
Gets the fieldType attribute of the FieldName object

Returns:
The fieldType value

openTag

public java.lang.String openTag()
Get the open tag name for this field

Returns:
tagname for this field, like <FOOBAR>

openTag

public java.lang.String openTag(java.util.List attributeList)
Get the open tag name for this field including the attributes named by the List of Attribute objects passed to this method

Returns:
tagname for this field, like <FOOBAR>

getRawName

public java.lang.String getRawName()
Get the "raw" name, which is the original encoded name in the PBS file, like Resource_List.nodect

Returns:
The rawName value

getDisplayName

public java.lang.String getDisplayName()
Get the display name, which is the name that is used for the XML tag, like display name for Resource_List.nodect is nodect

Returns:
The displayName value

closeTag

public java.lang.String closeTag()
Get the closed tag name for this field

Returns:
closed tagname for this field, like </FOOBAR>