Dali Provisional API
Release 3.2

org.eclipse.jpt.jpa.core.context.orm
Class OrmBaseEnumeratedConverter.MapKeyAdapter

java.lang.Object
  extended by org.eclipse.jpt.jpa.core.context.orm.OrmBaseEnumeratedConverter.MapKeyAdapter
All Implemented Interfaces:
OrmConverter.Adapter
Enclosing interface:
OrmBaseEnumeratedConverter

public static class OrmBaseEnumeratedConverter.MapKeyAdapter
extends Object
implements OrmConverter.Adapter


Method Summary
 OrmConverter buildConverter(OrmAttributeMapping parent, OrmXmlContextNodeFactory factory)
          Build a converter for specified mapping if the mapping's XML has the adapter's value set.
 OrmConverter buildNewConverter(OrmAttributeMapping parent, OrmXmlContextNodeFactory factory)
          Build a converter for specified mapping.
protected  OrmBaseEnumeratedConverter.Owner buildOwner(org.eclipse.jpt.jpa.core.resource.orm.v2_0.XmlMapKeyConvertibleMapping_2_0 mapping)
           
 void clearXmlValue(org.eclipse.jpt.jpa.core.resource.orm.XmlAttributeMapping xmlMapping)
          Clear the adapter's XML value from the specified XML mapping.
 Class<? extends Converter> getConverterType()
          Return the type of converter handled by the adapter.
static OrmBaseEnumeratedConverter.MapKeyAdapter instance()
           
 boolean isActive(org.eclipse.jpt.jpa.core.resource.orm.XmlAttributeMapping xmlMapping)
          Return whether the specified XML mapping has the adapter's value set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

instance

public static OrmBaseEnumeratedConverter.MapKeyAdapter instance()

getConverterType

public Class<? extends Converter> getConverterType()
Description copied from interface: OrmConverter.Adapter
Return the type of converter handled by the adapter.

Specified by:
getConverterType in interface OrmConverter.Adapter

buildConverter

public OrmConverter buildConverter(OrmAttributeMapping parent,
                                   OrmXmlContextNodeFactory factory)
Description copied from interface: OrmConverter.Adapter
Build a converter for specified mapping if the mapping's XML has the adapter's value set. Return null otherwise. This is used to build a converter during construction of the converter's mapping.

Specified by:
buildConverter in interface OrmConverter.Adapter

buildOwner

protected OrmBaseEnumeratedConverter.Owner buildOwner(org.eclipse.jpt.jpa.core.resource.orm.v2_0.XmlMapKeyConvertibleMapping_2_0 mapping)

isActive

public boolean isActive(org.eclipse.jpt.jpa.core.resource.orm.XmlAttributeMapping xmlMapping)
Description copied from interface: OrmConverter.Adapter
Return whether the specified XML mapping has the adapter's value set. If the adapter is active and the context mapping's converter does not match the adapter, the mapping will build a new converter (via the adapter).

Specified by:
isActive in interface OrmConverter.Adapter
See Also:
OrmConverter.Adapter.buildNewConverter(OrmAttributeMapping, OrmXmlContextNodeFactory)

buildNewConverter

public OrmConverter buildNewConverter(OrmAttributeMapping parent,
                                      OrmXmlContextNodeFactory factory)
Description copied from interface: OrmConverter.Adapter
Build a converter for specified mapping. This is used when the context model is synchronized with the resource model (and the resource model has changed) or when a client changes a mapping's converter. The appropriate setting in the XML mapping will be configured once the context converter has been added to the context model (see OrmConverter.initialize().

Specified by:
buildNewConverter in interface OrmConverter.Adapter
See Also:
#isActive(XmlConvertibleMapping)

clearXmlValue

public void clearXmlValue(org.eclipse.jpt.jpa.core.resource.orm.XmlAttributeMapping xmlMapping)
Description copied from interface: OrmConverter.Adapter
Clear the adapter's XML value from the specified XML mapping.

Specified by:
clearXmlValue in interface OrmConverter.Adapter

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.