org.compass.core.converter.mapping.xsem
Class XmlIdMappingConverter

java.lang.Object
  extended by org.compass.core.converter.mapping.xsem.XmlIdMappingConverter
All Implemented Interfaces:
Converter

public class XmlIdMappingConverter
extends Object
implements Converter

Responsible for converting XmlObject based on XmlIdMapping. Uses the XmlIdMapping value converter to actually convert the given value.

The converter executes the given xpath expression associated with XmlIdMapping and uses the FIRST one as the xml object to convert using the value converter.

Also note, that un-marshalling is not supported.

Author:
kimchy

Constructor Summary
XmlIdMappingConverter()
           
 
Method Summary
 boolean marshall(Resource resource, Object root, Mapping mapping, MarshallingContext context)
          Marshall the given Object to the given Resource.
 Object unmarshall(Resource resource, Mapping mapping, MarshallingContext context)
          Unmarshall the given Resource to the appropiate Object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XmlIdMappingConverter

public XmlIdMappingConverter()
Method Detail

marshall

public boolean marshall(Resource resource,
                        Object root,
                        Mapping mapping,
                        MarshallingContext context)
                 throws ConversionException
Description copied from interface: Converter
Marshall the given Object to the given Resource. Will use the mapping definition as to how to marshall the object.

Returns true if data was saved in the index, and it can be read as well (i.e. stored).

Specified by:
marshall in interface Converter
Parameters:
resource - The resource to marhsall the object to
root - The Object to marshall to the resource
mapping - The mapping definition of how to marshall the Object to the resoruce
context - The context for the current marhslling process
Returns:
true if data was saved in the the index that can be read.
Throws:
ConversionException

unmarshall

public Object unmarshall(Resource resource,
                         Mapping mapping,
                         MarshallingContext context)
                  throws ConversionException
Description copied from interface: Converter
Unmarshall the given Resource to the appropiate Object.

Specified by:
unmarshall in interface Converter
Parameters:
resource - The resource to unmarshall into an Object
mapping - The mapping definition of how to unmarshall the Resource into an Object
context - The context for the current marshalling process
Returns:
The object unmarshalled
Throws:
ConversionException


Copyright (c) 2004-2009 The Compass Project.