org.compass.core.converter.mapping.osem
Class ClassDynamicPropertyMappingConverter

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

public class ClassDynamicPropertyMappingConverter
extends Object
implements Converter

Author:
kimchy

Constructor Summary
ClassDynamicPropertyMappingConverter()
           
 
Method Summary
protected  void addProperty(Resource resource, ClassDynamicPropertyMapping mapping, MarshallingContext context, String name, Object valueObj)
           
protected  String getNullValue(ResourcePropertyMapping resourcePropertyMapping, MarshallingContext context)
          If the converter handle nulls, the value that will be stored in the search engine for null values (during the marshall process).
protected  boolean handleNulls(ResourcePropertyMapping resourcePropertyMapping, MarshallingContext context)
          Should the converter handle nulls?
 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

ClassDynamicPropertyMappingConverter

public ClassDynamicPropertyMappingConverter()
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

addProperty

protected void addProperty(Resource resource,
                           ClassDynamicPropertyMapping mapping,
                           MarshallingContext context,
                           String name,
                           Object valueObj)

handleNulls

protected boolean handleNulls(ResourcePropertyMapping resourcePropertyMapping,
                              MarshallingContext context)

Should the converter handle nulls? Handling nulls means should the converter process nulls or not. Usually the converter will not persist null values, but sometimes it might be needed (MarshallingContext.handleNulls()).

If a specific null value is configured with the ResourcePropertyMapping then the converter will always handle nulls and write it.

Parameters:
context - The marshalling context
Returns:
true if the converter should handle null values

getNullValue

protected String getNullValue(ResourcePropertyMapping resourcePropertyMapping,
                              MarshallingContext context)
If the converter handle nulls, the value that will be stored in the search engine for null values (during the marshall process). Uses ResourcePropertyMapping.getNullValue().

Parameters:
resourcePropertyMapping - The resource proeprty mapping to get the null value from
context - The marshalling context
Returns:
Null value that will be inserted for nulls.


Copyright (c) 2004-2009 The Compass Project.