org.compass.core.mapping.xsem.builder
Class XmlContentMappingBuilder

java.lang.Object
  extended by org.compass.core.mapping.xsem.builder.XmlContentMappingBuilder

public class XmlContentMappingBuilder
extends Object

A builder allowing to constrcut xml content mapping definition allowing to store the actual XML content withn the index to and be able to rebuild the XmlObject back from the index (or get the actual xml string).

Author:
kimchy
See Also:
XSEM.content(String)

Field Summary
(package private)  XmlContentMapping mapping
           
 
Constructor Summary
XmlContentMappingBuilder(String name)
          Constructs a new XML content mapping with the given name.
 
Method Summary
 XmlContentMappingBuilder converter(Converter converter)
          Sets the actual converter that will be used to convert the JSON content.
 XmlContentMappingBuilder converter(String converterName)
          Sets the lookup converter name (registered with Compass) that will be used to convert the XML content.
 XmlContentMappingBuilder store(Property.Store store)
          Specifies whether and how a property will be stored.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mapping

final XmlContentMapping mapping
Constructor Detail

XmlContentMappingBuilder

public XmlContentMappingBuilder(String name)
Constructs a new XML content mapping with the given name. The XML string will be stored as a property within the Resource in the index under the name.

Method Detail

store

public XmlContentMappingBuilder store(Property.Store store)
Specifies whether and how a property will be stored. Deftauls to Property.Store.YES. Note, Property.Store.NO is not valid here.


converter

public XmlContentMappingBuilder converter(String converterName)
Sets the lookup converter name (registered with Compass) that will be used to convert the XML content. Defaults to XmlContentMappingConverter.


converter

public XmlContentMappingBuilder converter(Converter converter)
Sets the actual converter that will be used to convert the JSON content. Defaults to JsonContentMappingConverter.



Copyright (c) 2004-2009 The Compass Project.