com.sage.orion.sdata.servlet.accpac
Class LookupField

java.lang.Object
  com.sage.orion.sdata.servlet.accpac.JiBXConfigurationAbstractResource
      com.sage.orion.sdata.servlet.accpac.LookupField

All Implemented Interfaces:

JiBXConfigurationResource

public class LookupField
extends JiBXConfigurationAbstractResource

The LookupField is a simple structure used in parsing the ViewResourceMapping files.

A lookup field defines which field of a ReferencedResource is to be exported from the main Resource, and by what name it will be exported.

Like the other similar classes, it is designed to be built by the JiBX parser and then queried elsewhere.

Constructor Summary

LookupField()
constructs an instance of the LookupField class.

LookupField(java.lang.String name, java.lang.String viewFieldName)
constructs an instance of the LookupField class with the given local SData and referenced Accpac names.

Method Summary

java.lang.String	getName() gets the SData name of the looked up field
java.lang.String	getViewFieldName() gets the internal name.
protected void	onEndBuilding() This will be called at the end of the building phase.
void	setName(java.lang.String name) sets the name.
void	setViewFieldName(java.lang.String name) sets the internal name.

Methods inherited from class com.sage.orion.sdata.servlet.accpac.JiBXConfigurationAbstractResource

addConfigurationError, endBuilding, ensureStillBuilding, getConfigurationErrors

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupField

public LookupField()

constructs an instance of the LookupField class.

LookupField

public LookupField(java.lang.String name,
                   java.lang.String viewFieldName)

constructs an instance of the LookupField class with the given local SData and referenced Accpac names.

Parameters:

name - the SData name of the looked up field

viewFieldName - the internal (Accpac field) name in the related resource

Method Detail

getName

public java.lang.String getName()

gets the SData name of the looked up field

Returns:

the SData name of the looked up field

getViewFieldName

public java.lang.String getViewFieldName()

gets the internal name. This is the Accpac field name in the related resource.

Returns:

the internal name of the looked up field in the referenced resource.

setName

public void setName(java.lang.String name)

sets the name. This is the SData field name by which the field will be known

Parameters:

name - the SData name by which the field will be known

setViewFieldName

public void setViewFieldName(java.lang.String name)

sets the internal name. This is the Accpac field name in the related resource.

Parameters:

name - the internal Accpac name of the field to be looked up

onEndBuilding

protected void onEndBuilding()

This will be called at the end of the building phase. The subclass must perform any required actions at that time, such as sealing lists, checking configurations, etc. It may call JiBXConfigurationAbstractResource.addConfigurationError(java.lang.String) during this call.

Specified by:

onEndBuilding in class JiBXConfigurationAbstractResource