Package com.caplin.datasource.fields

Interface FieldManager

public interface FieldManager

This interface allows access to fields name and numbers configured in fields.conf files.

Method Summary

Modifier and Type	Method	Description
FieldInfo	getFieldByName(String name)	Given the field's name, returns a structure containing both the field's name and number.
FieldInfo	getFieldByNumber(int num)	Given the field's number, returns a structure containing both the field's name and number.
List<FieldInfo>	getFields()	Returns a list of the available fields.
boolean	validateFields()	Should fields be validated to ensure they're defined.

Method Details

getFieldByName

FieldInfo getFieldByName(String name)

Given the field's name, returns a structure containing both the field's name and number.

Parameters:

name - Field

Returns:

A FieldInfo with the field's information, null if the name doesn't exist

getFieldByNumber

FieldInfo getFieldByNumber(int num)

Given the field's number, returns a structure containing both the field's name and number.

Parameters:

num - Field

Returns:

A FieldInfo with the field's information, null if the number doesn't exist

getFields

List<FieldInfo> getFields()

Returns a list of the available fields.

Returns:

a list of the available fields.

validateFields

boolean validateFields()

Should fields be validated to ensure they're defined.

Returns:

Does the field manager require fields to be validated to ensure they're defined;