org.eclipse.jpt.jaxb.core.context
Interface JaxbClassMapping

All Superinterfaces:

IAdaptable, JaxbContextNode, JaxbNode, JaxbTypeMapping, JptResourceTypeReference, Model, XmlAccessOrderHolder, XmlAccessTypeHolder

All Known Subinterfaces:

ELClassMapping, JavaClassMapping, OxmJavaType

public interface JaxbClassMapping
extends JaxbTypeMapping, XmlAccessTypeHolder, XmlAccessOrderHolder

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

3.3

Nested Class Summary

static class	JaxbClassMapping.AttributesTransformer
static class	JaxbClassMapping.SuperClassTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	ATTRIBUTES_COLLECTION string associated with changes to the "attributes" collection
static org.eclipse.jpt.common.utility.transformer.Transformer<JaxbClassMapping,Iterable<? extends JaxbPersistentAttribute>>	ATTRIBUTES_TRANSFORMER
static String	FACTORY_METHOD_PROPERTY
static String	INCLUDED_ATTRIBUTES_COLLECTION string associated with changes to the "included attributes" collection
static String	PROP_ORDER_LIST
static String	SPECIFIED_FACTORY_CLASS_PROPERTY
static org.eclipse.jpt.common.utility.transformer.Transformer<JaxbClassMapping,JaxbClassMapping>	SUPER_CLASS_TRANSFORMER
static String	SUPERCLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbTypeMapping

XML_ROOT_ELEMENT_PROPERTY, XML_SEE_ALSO_PROPERTY, XML_TRANSIENT_PROPERTY

Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessTypeHolder

ACCESS_TYPE_PROPERTY, DEFAULT_ACCESS_TYPE_PROPERTY, SPECIFIED_ACCESS_TYPE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessOrderHolder

DEFAULT_ACCESS_ORDER_PROPERTY, SPECIFIED_ACCESS_ORDER_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

void	addProp(int index, String prop)
JaxbAttributesContainer	buildIncludedAttributesContainer(JaxbClassMapping parent, JaxbAttributesContainer.Context context) Build an included attributes container that process attribute metadata of this class with the context of the owning class
Iterable<JaxbPersistentAttribute>	getAllLocallyDefinedAttributes() Return all attributes that are defined by this class.
Iterable<? extends JaxbPersistentAttribute>	getAttributes() Return the attributes defined on this class (not its superclass)
int	getAttributesSize()
String	getFactoryClass()
String	getFactoryMethod() factory method corresponds to the XmlType annotation factoryMethod element
Iterable<JaxbPersistentAttribute>	getIncludedAttributes() Included attributes come from any direct superclasses that are mapped as @XmlTransient.
int	getIncludedAttributesSize()
Iterable<JaxbPersistentAttribute>	getInheritedAttributes() Inherited attributes are any attributes this class mapping has whose source is a superclass.
String	getProp(int index)
org.eclipse.jpt.common.utility.iterable.ListIterable<String>	getPropOrder() propOrder corresponds to the XmlType annotation propOrder element
int	getPropOrderSize()
String	getSpecifiedFactoryClass() factory class corresponds to the XmlType annotation factoryClass element
JaxbClassMapping	getSuperclass()
JaxbAttributeMapping	getXmlIdMapping() Return the id attribute mapping for this class mapping, if it has one.
void	moveProp(int targetIndex, int sourceIndex)
void	removeProp(int index)
void	removeProp(String prop)
void	setFactoryMethod(String factoryMethod)
void	setSpecifiedFactoryClass(String factoryClass)

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbTypeMapping

getJaxbPackage, getQName, getReferencedXmlTypeNames, getTypeKind, getTypeName, getXmlRootElement, getXmlSeeAlso, getXsdTypeDefinition, hasRootElementInHierarchy, isXmlTransient

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessTypeHolder

getAccessType, getDefaultAccessType, getSpecifiedAccessType, setSpecifiedAccessType

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessOrderHolder

getAccessOrder, getDefaultAccessOrder, getSpecifiedAccessOrder, setSpecifiedAccessOrder

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbContextNode

getCompletionProposals, getContextRoot, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jaxb.core.JaxbNode

getJaxbProject, getParent, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

SPECIFIED_FACTORY_CLASS_PROPERTY

static final String SPECIFIED_FACTORY_CLASS_PROPERTY

See Also:

Constant Field Values

FACTORY_METHOD_PROPERTY

static final String FACTORY_METHOD_PROPERTY

See Also:

Constant Field Values

PROP_ORDER_LIST

static final String PROP_ORDER_LIST

See Also:

Constant Field Values

SUPERCLASS_PROPERTY

static final String SUPERCLASS_PROPERTY

See Also:

Constant Field Values

SUPER_CLASS_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<JaxbClassMapping,JaxbClassMapping> SUPER_CLASS_TRANSFORMER

ATTRIBUTES_COLLECTION

static final String ATTRIBUTES_COLLECTION

string associated with changes to the "attributes" collection

See Also:

Constant Field Values

ATTRIBUTES_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<JaxbClassMapping,Iterable<? extends JaxbPersistentAttribute>> ATTRIBUTES_TRANSFORMER

INCLUDED_ATTRIBUTES_COLLECTION

static final String INCLUDED_ATTRIBUTES_COLLECTION

string associated with changes to the "included attributes" collection

See Also:

Constant Field Values

Method Detail

getFactoryClass

String getFactoryClass()

getSpecifiedFactoryClass

String getSpecifiedFactoryClass()

factory class corresponds to the XmlType annotation factoryClass element

setSpecifiedFactoryClass

void setSpecifiedFactoryClass(String factoryClass)

getFactoryMethod

String getFactoryMethod()

factory method corresponds to the XmlType annotation factoryMethod element

setFactoryMethod

void setFactoryMethod(String factoryMethod)

getPropOrder

org.eclipse.jpt.common.utility.iterable.ListIterable<String> getPropOrder()

propOrder corresponds to the XmlType annotation propOrder element

getProp

String getProp(int index)

getPropOrderSize

int getPropOrderSize()

addProp

void addProp(int index,
             String prop)

removeProp

void removeProp(int index)

removeProp

void removeProp(String prop)

moveProp

void moveProp(int targetIndex,
              int sourceIndex)

getSuperclass

JaxbClassMapping getSuperclass()

getAttributes

Iterable<? extends JaxbPersistentAttribute> getAttributes()

Return the attributes defined on this class (not its superclass)

getAttributesSize

int getAttributesSize()

getIncludedAttributes

Iterable<JaxbPersistentAttribute> getIncludedAttributes()

Included attributes come from any direct superclasses that are mapped as @XmlTransient. (As opposed to inherited attributes, which a class has by way of any mapped superclasses.) If there is an intervening class that is not transient, then that class will hold any included attributes from any direct superclass that are mapped as @XmlTransient.

See Also:

getSuperclass()

getIncludedAttributesSize

int getIncludedAttributesSize()

getAllLocallyDefinedAttributes

Iterable<JaxbPersistentAttribute> getAllLocallyDefinedAttributes()

Return all attributes that are defined by this class. This is the combined set of #getAttributes() and #getIncludedAttributes()

getInheritedAttributes

Iterable<JaxbPersistentAttribute> getInheritedAttributes()

Inherited attributes are any attributes this class mapping has whose source is a superclass. Inherited attributes include included attributes.

buildIncludedAttributesContainer

JaxbAttributesContainer buildIncludedAttributesContainer(JaxbClassMapping parent,
                                                         JaxbAttributesContainer.Context context)

Build an included attributes container that process attribute metadata of this class with the context of the owning class

getXmlIdMapping

JaxbAttributeMapping getXmlIdMapping()

Return the id attribute mapping for this class mapping, if it has one. (Will return the first one it finds, if this class has more than one.)