net.sf.mpxj

Class UserDefinedField

java.lang.Object

net.sf.mpxj.UserDefinedField

All Implemented Interfaces:

FieldType, MpxjEnum

public class UserDefinedField
extends Object
implements FieldType

Represents a user defined field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserDefinedField.Builder User defined field builder.

Constructor Summary

Constructors

Constructor and Description
UserDefinedField(Integer uniqueID, String internalName, String externalName, FieldTypeClass fieldTypeClass, boolean summaryTaskOnly, DataType dataType) Deprecated. use the new version of this constructor
UserDefinedField(UniqueIdObjectSequenceProvider file, Integer uniqueID, String internalName, String externalName, FieldTypeClass fieldTypeClass, boolean summaryTaskOnly, DataType dataType) Deprecated. use the Builder class

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() Retrieve the data type of this field.
FieldTypeClass	getFieldTypeClass() Retrieve an enum representing the type of entity to which this field belongs.
String	getName() Retrieve the name of this field using the default locale.
String	getName(Locale locale) Retrieve the name of this field using the supplied locale.
boolean	getSummaryTaskOnly() For a user defined field with a FieldTypeClas of TASK, this method returns true if this is a user defined field for WBS (represented as summary tasks in MPXJ).
Integer	getUniqueID() Retrieve the unique ID.
FieldType	getUnitsType() Retrieve the associated units field, if any.
int	getValue() This method is used to retrieve the int value (not the ordinal) associated with an enum instance.
String	name() Retrieve the enum name.
void	setDataType(DataType dataType) Deprecated. use the Builder class
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserDefinedField

@Deprecated
public UserDefinedField(Integer uniqueID,
                                     String internalName,
                                     String externalName,
                                     FieldTypeClass fieldTypeClass,
                                     boolean summaryTaskOnly,
                                     DataType dataType)

Deprecated. use the new version of this constructor

Constructor.

Parameters:

uniqueID - unique ID

internalName - internal name for this field

externalName - user-visible name for this field

fieldTypeClass - type of entity on which this field can be used

summaryTaskOnly - flag is true if this UDF can only be applied to summary tasks (WBS)

dataType - data type of this field

UserDefinedField

@Deprecated
public UserDefinedField(UniqueIdObjectSequenceProvider file,
                                     Integer uniqueID,
                                     String internalName,
                                     String externalName,
                                     FieldTypeClass fieldTypeClass,
                                     boolean summaryTaskOnly,
                                     DataType dataType)

Deprecated. use the Builder class

Constructor.

Parameters:

file - parent file

uniqueID - unique ID

internalName - internal name for this field

externalName - user-visible name for this field

fieldTypeClass - type of entity on which this field can be used

summaryTaskOnly - flag is true if this UDF can only be applied to summary tasks (WBS)

dataType - data type of this field

Method Detail

getValue

public int getValue()

Description copied from interface: MpxjEnum

This method is used to retrieve the int value (not the ordinal) associated with an enum instance.

Specified by:

getValue in interface MpxjEnum

Returns:

enum value

getUniqueID

public Integer getUniqueID()

Retrieve the unique ID.

Returns:

unique ID

getSummaryTaskOnly

public boolean getSummaryTaskOnly()

For a user defined field with a FieldTypeClas of TASK, this method returns true if this is a user defined field for WBS (represented as summary tasks in MPXJ).

Returns:

true if this is a WBS user defined field

getFieldTypeClass

public FieldTypeClass getFieldTypeClass()

Description copied from interface: FieldType

Retrieve an enum representing the type of entity to which this field belongs.

Specified by:

getFieldTypeClass in interface FieldType

Returns:

field type class

getName

public String getName()

Description copied from interface: FieldType

Retrieve the name of this field using the default locale.

Specified by:

getName in interface FieldType

Returns:

field name

name

public String name()

Description copied from interface: FieldType

Retrieve the enum name.

Specified by:

name in interface FieldType

Returns:

enum name

getName

public String getName(Locale locale)

Description copied from interface: FieldType

Retrieve the name of this field using the supplied locale.

Specified by:

getName in interface FieldType

Parameters:

locale - target locale

Returns:

field name

getDataType

public DataType getDataType()

Description copied from interface: FieldType

Retrieve the data type of this field.

Specified by:

getDataType in interface FieldType

Returns:

data type

setDataType

@Deprecated
public void setDataType(DataType dataType)

Deprecated. use the Builder class

Set the data type of this field.

Parameters:

dataType - data type

getUnitsType

public FieldType getUnitsType()

Description copied from interface: FieldType

Retrieve the associated units field, if any.

Specified by:

getUnitsType in interface FieldType

Returns:

units field

toString

public String toString()

Overrides:

toString in class Object