alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator Class Reference

Inheritance diagram for alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator:

Collaboration diagram for alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator:

Public Member Functions
ComponentStates	componentState ()
String	name ()
XmlEntityStruct	createObsProposal ()
int	dumbMethod (String somevalue)
XmlEntityStruct[]	getAllSchedBlocks ()
void	addNewSchedBlocks (XmlEntityStruct[] newSchedBlocks)
XmlEntityStruct	getBestSchedBlock ()
void	xmlInOutMethod (XmlEntityStruct opsPropIn, XmlEntityStructHolder schedBlockOut)
ObsProjectTree	getEntireTreeInAStruct ()
String	sayHello ()
void	exceptionMethod () throws XmlComponentErrorEx
Package Functions
	IFTranslator (XmlComponentJ componentImpl, XmlComponentOperations defaultTranslator, Logger logger)
Private Attributes
boolean	m_useDefaultTranslator = true
XmlComponentJ	m_componentImpl
XmlComponentOperations	m_defaultTranslator
EntitySerializer	m_entSer
Logger	m_ifTransLogger

Detailed Description

Interface translator class that presents serialized XML toward the container, but presents the corresponding Java binding objects toward the component implementation.

XmlComponentHelper does not really need to provide such a translator class at all, since the container can do all necessary XML (de-)serializations to mediate between the CORBA interface XmlComponentOperations and XmlComponentJ transparently.

Nontheless we want to illustrate the use of the _getInterfaceTranslator method. Even if the container can perform the translation between the various XML method parameters and return types, we still might want to be in full control of this for selected component interface methods.

In the method implementations of IFTranslator, the private instance variable m_useDefaultTranslator controls whether the translation should be delegated to the container (represented by the m_defaultTranslator member object), or if it should be carried out by hand (using the methods marshalEntity and unmarshalEntity). For a real application, we would of course have more fine-grained control on the method level, and likely implement either automatic or manual parameter translation, but not both to choose from. This is done here only for demo purposes.

Constructor & Destructor Documentation

alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::IFTranslator	(	XmlComponentJ	componentImpl,
		XmlComponentOperations	defaultTranslator,
		Logger	logger
	)			`[inline, package]`

References alma::acs::entityutil::EntitySerializer::getEntitySerializer(), m_componentImpl, m_defaultTranslator, m_entSer, and m_ifTransLogger.

Member Function Documentation

void alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::addNewSchedBlocks ( XmlEntityStruct[] newSchedBlocks ) [inline]

See also:: alma.demo.XmlComponentOperations::addNewSchedBlocks(alma.xmlentity.XmlEntityStruct[])

References alma::demo::XmlComponentOperations::addNewSchedBlocks(), m_defaultTranslator, m_ifTransLogger, m_useDefaultTranslator, and alma::xmlentity::XmlEntityStruct::xmlString.

ComponentStates alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::componentState ( ) [inline]

Implements alma::ACS::ACSComponentOperations.

References alma::ACS::ACSComponentOperations::componentState(), and m_componentImpl.

XmlEntityStruct alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::createObsProposal ( ) [inline]

See also:: alma.demo.XmlComponentOperations::createObsProposal()

Implements alma::demo::XmlComponentOperations.

References alma::demo::XmlComponentJ::createObsProposal(), alma::demo::XmlComponentOperations::createObsProposal(), m_componentImpl, m_defaultTranslator, m_entSer, m_useDefaultTranslator, and alma::acs::entityutil::EntitySerializer::serializeEntity().

int alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::dumbMethod ( String somevalue ) [inline]

See also:: alma.demo.XmlComponentOperations::dumbMethod(java.lang.String)

References alma::demo::XmlComponentJ::dumbMethod(), and m_componentImpl.

void alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::exceptionMethod ( ) throws XmlComponentErrorEx [inline]

Implements alma::demo::XmlComponentOperations.

References alma::demo::XmlComponentOperations::exceptionMethod(), and m_defaultTranslator.

XmlEntityStruct [] alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::getAllSchedBlocks ( ) [inline]

See also:: alma.demo.XmlComponentOperations::getAllSchedBlocks()

Implements alma::demo::XmlComponentOperations.

References alma::demo::XmlComponentJ::getAllSchedBlocks(), alma::demo::XmlComponentOperations::getAllSchedBlocks(), m_componentImpl, m_defaultTranslator, m_entSer, m_useDefaultTranslator, and alma::acs::entityutil::EntitySerializer::serializeEntity().

XmlEntityStruct alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::getBestSchedBlock ( ) [inline]

See also:: alma.demo.XmlComponentOperations::getBestSchedBlock()

Implements alma::demo::XmlComponentOperations.

References alma::demo::XmlComponentJ::getBestSchedBlock(), alma::demo::XmlComponentOperations::getBestSchedBlock(), m_componentImpl, m_defaultTranslator, m_entSer, m_useDefaultTranslator, and alma::acs::entityutil::EntitySerializer::serializeEntity().

ObsProjectTree alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::getEntireTreeInAStruct ( ) [inline]

See also:: alma.demo.XmlComponentOperations::getEntireTreeInAStruct()

Implements alma::demo::XmlComponentOperations.

References alma::demo::XmlComponentJ::getEntireTreeInAStruct(), m_componentImpl, m_defaultTranslator, m_entSer, m_ifTransLogger, m_useDefaultTranslator, alma::demo::ObsProjectTreeJ::prop, alma::demo::ObsProjectTreeJ::schedBlocks, and alma::acs::entityutil::EntitySerializer::serializeEntity().

String alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::name ( ) [inline]

Implements alma::ACS::ACSComponentOperations.

References m_componentImpl, and alma::ACS::ACSComponentOperations::name().

String alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::sayHello ( ) [inline]

See also:: alma.demo.XmlComponentOperations::sayHello()

Implements alma::demo::XmlComponentOperations.

References m_componentImpl, and alma::demo::XmlComponentJ::sayHello().

void alma::demo::XmlComponentImpl::XmlComponentHelper::IFTranslator::xmlInOutMethod	(	XmlEntityStruct	opsPropIn,
		XmlEntityStructHolder	schedBlockOut
	)			`[inline]`