Package com.portal.bas

Class PFieldSpecFactory

java.lang.Object

com.portal.bas.PFieldSpecFactory

public class PFieldSpecFactory
extends Object

PFieldSpecFactory is a class used internally by the BAS framework to generate a PFieldSpecification from a String description passed in from the client side of an application. The PFieldSpecification is used to specify the fields to include in an flist.

Version:

7

Author:

Larry Lynch-Freshner

Constructor Summary

Constructors

Constructor	Description
PFieldSpecFactory()

Method Summary

Modifier and Type	Method	Description
static PDataFieldSpecification	createDataSpec(String description)
static PFieldSpecification	createSpec(Field field)
static PFieldSpecification	createSpec(Field field, int elem)
static PFieldSpecification	createSpec(String description)

Methods inherited from class java.lang.Object

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

Constructor Details

PFieldSpecFactory

public PFieldSpecFactory()

Method Details

createDataSpec

public static PDataFieldSpecification createDataSpec(String description)
                                              throws PBadFieldDescriptionException

Parameters:

description - a String that describes the field

Returns:

The field specification.

Throws:

PBadFieldDescriptionException - thrown when a field description fails to describe the right kind of field (or fails to provide any field) for the intended operation.

createSpec

public static PFieldSpecification createSpec(Field field)
                                      throws PBadFieldDescriptionException

Parameters:

field - a Field object

Returns:

The field specification's position in the list.

Throws:

PBadFieldDescriptionException - thrown when a field description fails to describe the right kind of field (or fails to provide any field) for the intended operation.

createSpec

public static PFieldSpecification createSpec(Field field,
 int elem)
                                      throws PBadFieldDescriptionException

Parameters:

field - a Field object

elem - the field's position

Returns:

The updated list of fields.

Throws:

PBadFieldDescriptionException - thrown when a field description fails to describe the right kind of field (or fails to provide any field) for the intended operation.

createSpec

public static PFieldSpecification createSpec(String description)
                                      throws PBadFieldDescriptionException

Parameters:

description - a String that describes a field

Returns:

The field specification that matches the description.

Throws:

PBadFieldDescriptionException - thrown when a field description fails to describe the right kind of field (or fails to provide any field) for the intended operation.