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

All Superinterfaces:

IAdaptable, JaxbContextNode, JaxbNode, JptResourceTypeReference, Model

All Known Subinterfaces:

ELXmlAnyAttributeMapping, ELXmlAnyElementMapping, ELXmlAttributeMapping, ELXmlElementMapping, ELXmlElementsMapping, ELXmlInverseReferenceMapping, ELXmlJoinNodesMapping, ELXmlNamedNodeMapping, ELXmlValueMapping, XmlAnyAttributeMapping, XmlAnyElementMapping, XmlAttributeMapping, XmlElementMapping, XmlElementRefMapping, XmlElementRefsMapping, XmlElementsMapping, XmlNamedNodeMapping, XmlNodeMapping, XmlValueMapping

public interface JaxbAttributeMapping
extends JaxbContextNode

Represents a JAXB attribute mapping.

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.0

Nested Class Summary

static class

JaxbAttributeMapping.ReferencedXmlTypeNamesTransformer

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

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	DEFAULT_PROPERTY
static org.eclipse.jpt.common.utility.transformer.Transformer<JaxbAttributeMapping,Iterable<String>>	REFERENCED_XML_TYPE_NAMES_TRANSFORMER

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

String	getBoundTypeName() Return the (fully qualified) type of the attribute (or the item type if in a collection/array)
JaxbClassMapping	getClassMapping()
String	getDataTypeName() Return the (fully qualified) type of the data actually written to xml.
XsdTypeDefinition	getDataTypeXsdTypeDefinition() Return the schema type associated with the value type.
JavaResourceAttribute	getJavaResourceAttribute()
String	getKey()
JaxbPersistentAttribute	getPersistentAttribute()
Iterable<String>	getReferencedXmlTypeNames() Return all directly referenced types, fully qualified.
String	getValueTypeName() Return the (fully qualified) type used to map the bound type.
boolean	isDefault() Return whether the mapping is its attribute's default mapping (as opposed to its specified mapping).
boolean	isParticleMapping() Return whether the attribute is mapped to a particle (e.g.
boolean	isTransient() Return whether the attribute is specifically excluded from being mapped (e.g.

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

DEFAULT_PROPERTY

static final String DEFAULT_PROPERTY

See Also:

Constant Field Values

REFERENCED_XML_TYPE_NAMES_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<JaxbAttributeMapping,Iterable<String>> REFERENCED_XML_TYPE_NAMES_TRANSFORMER

Method Detail

getKey

String getKey()

getJavaResourceAttribute

JavaResourceAttribute getJavaResourceAttribute()

getPersistentAttribute

JaxbPersistentAttribute getPersistentAttribute()

getClassMapping

JaxbClassMapping getClassMapping()

isDefault

boolean isDefault()

Return whether the mapping is its attribute's default mapping (as opposed to its specified mapping).

getBoundTypeName

String getBoundTypeName()

Return the (fully qualified) type of the attribute (or the item type if in a collection/array)

getValueTypeName

String getValueTypeName()

Return the (fully qualified) type used to map the bound type. (Usually the same as the value type, except when an XmlJavaTypeAdapter is used.)

getDataTypeName

String getDataTypeName()

Return the (fully qualified) type of the data actually written to xml. (Usually the same as the value type, except when an XmlIDREF is used.)

getDataTypeXsdTypeDefinition

XsdTypeDefinition getDataTypeXsdTypeDefinition()

Return the schema type associated with the value type. May be null.

getReferencedXmlTypeNames

Iterable<String> getReferencedXmlTypeNames()

Return all directly referenced types, fully qualified. (Used for constructing Jaxb context)

isParticleMapping

boolean isParticleMapping()

Return whether the attribute is mapped to a particle (e.g. XmlElement, XmlElements, XmlElementRef, XmlElementRefs)

isTransient

boolean isTransient()

Return whether the attribute is specifically excluded from being mapped (e.g. XmlTransient)