Author: desruisseaux
Date: Tue Mar 19 15:31:56 2013
New Revision: 1458338
URL: http://svn.apache.org/r1458338
Log:
Added JAXB-related classes which are going to be needed by metadata.
Added:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java
(with props)
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java
(with props)
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/NonMarshalledAuthority.java
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/NonMarshalledAuthority.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/NonMarshalledAuthority.java?rev=1458338&r1=1458337&r2=1458338&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/NonMarshalledAuthority.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/NonMarshalledAuthority.java
[UTF-8] Tue Mar 19 15:31:56 2013
@@ -37,8 +37,8 @@ import org.apache.sis.xml.IdentifierSpac
*
* <ul>
* <li>The XML attributes declared by ISO 19139 specification in the {@code
gco:PropertyType}
- * element: {@code gml:id}, {@code gco:uuid} and {@code xlink:href}.
Those attributes are not
- * part of the ISO 19115 specification. Those authorities are declared
in the
+ * element: {@code gml:id}, {@code gco:uuid} and {@code xlink:href}.
Those attributes are
+ * not part of the ISO 19115 specification. Those authorities are
declared in the
* {@link IdentifierSpace} interfaces.</li>
*
* <li>ISO 19115 attributes that we choose, for the SIS implementation, to
merge with
Added:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java?rev=1458338&view=auto
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java
(added)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java
[UTF-8] Tue Mar 19 15:31:56 2013
@@ -0,0 +1,166 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.sis.internal.jaxb.gco;
+
+import java.util.UUID;
+
+import org.apache.sis.xml.XLink;
+import org.apache.sis.xml.IdentifierMap;
+import org.apache.sis.xml.IdentifierSpace;
+import org.apache.sis.xml.IdentifiedObject;
+import org.apache.sis.xml.ReferenceResolver;
+import org.apache.sis.util.ArraysExt;
+import org.apache.sis.internal.jaxb.MarshalContext;
+import org.apache.sis.internal.jaxb.IdentifierMapAdapter;
+import org.apache.sis.internal.jaxb.SpecializedIdentifier;
+
+
+/**
+ * The {@code gco:ObjectReference} XML attribute group is included by all
metadata wrappers defined
+ * in the {@link org.apache.sis.internal.jaxb.metadata} package. The
attributes of interest defined
+ * in this group are {@code uuidref}, {@code xlink:href}, {@code xlink:role},
{@code xlink:arcrole},
+ * {@code xlink:title}, {@code xlink:show} and {@code xlink:actuate}.
+ *
+ * <p>This {@code gco:ObjectReference} group is complementary to {@code
gco:ObjectIdentification},
+ * which define the {@code id} and {@code uuid} attributes to be supported by
all metadata
+ * implementations in the public {@link org.apache.sis.metadata.iso} package
and sub-packages.</p>
+ *
+ * @author Martin Desruisseaux (Geomatys)
+ * @since 0.3 (derived from geotk-3.18)
+ * @version 0.3
+ * @module
+ *
+ * @see PropertyType
+ * @see ObjectIdentification
+ * @see <a
href="http://schemas.opengis.net/iso/19139/20070417/gco/gcoBase.xsd";>OGC
schema</a>
+ * @see <a href="http://jira.geotoolkit.org/browse/GEOTK-165";>GEOTK-165</a>
+ */
+final class ObjectReference {
+ /**
+ * A URN to an external resources, or to an other part of a XML document,
or an identifier.
+ * The {@code uuidref} attribute is used to refer to an XML element that
has a corresponding
+ * {@code uuid} attribute.
+ *
+ * @see <a
href="http://www.schemacentral.com/sc/niem21/a-uuidref-1.html";>Usage of
uuidref</a>
+ */
+ String anyUUID;
+
+ /**
+ * The {@code xlink} attributes, or {@code null} if none.
+ */
+ XLink xlink;
+
+ /**
+ * The parsed value of {@link #anyUUID}, computed when first needed.
+ */
+ private transient UUID uuid;
+
+ /**
+ * Creates an initially empty object reference.
+ */
+ ObjectReference() {
+ }
+
+ /**
+ * Creates an object reference initialized to the given value.
+ */
+ ObjectReference(final UUID uuid, final String anyUUID, final XLink link) {
+ this.uuid = uuid;
+ this.anyUUID = anyUUID;
+ this.xlink = link;
+ }
+
+ /**
+ * Parses the given string as a UUID.
+ *
+ * @param context The marshalling context, or {@code null} if none.
+ * @param anyUUID The string to parse, or {@code null}.
+ * @return The parsed UUID, or {@code null}.
+ * @throws IllegalArgumentException If {@code anyUUID} can not be parsed.
+ */
+ static UUID toUUID(final MarshalContext context, final String anyUUID)
throws IllegalArgumentException {
+ return (anyUUID != null) ?
MarshalContext.converter(context).toUUID(context, anyUUID) : null;
+ }
+
+ /**
+ * If the given metadata object is null, tries to get an instance from the
identifiers
+ * declared in this {@code ObjectReference}. If the given metadata object
is non-null,
+ * assigns to that object the identifiers declared in this {@code
ObjectReference}.
+ *
+ * <p>This method is invoked at unmarshalling time.</p>
+ *
+ * @param <T> The compile-time type of the {@code type} argument.
+ * @param context The marshalling context, or {@code null} if none.
+ * @param type The expected type of the metadata object.
+ * @param metadata The metadata object, or {@code null}.
+ * @return A metadata object for the identifiers, or {@code null}
+ * @throws IllegalArgumentException If the {@link #anyUUID} field can not
be parsed.
+ */
+ final <T> T resolve(final MarshalContext context, final Class<T> type, T
metadata) throws IllegalArgumentException {
+ if (uuid == null) {
+ uuid = toUUID(context, anyUUID);
+ }
+ if (metadata == null) {
+ final ReferenceResolver resolver =
MarshalContext.resolver(context);
+ if ((uuid == null || (metadata = resolver.resolve(context, type,
uuid )) == null) &&
+ (xlink == null || (metadata = resolver.resolve(context, type,
xlink)) == null))
+ {
+ // Failed to find an existing metadata instance.
+ // Creates an empty instance with the identifiers.
+ int count = 0;
+ SpecializedIdentifier<?>[] identifiers = new
SpecializedIdentifier<?>[2];
+ if (uuid != null) identifiers[count++] = new
SpecializedIdentifier<>(IdentifierSpace.UUID, uuid);
+ if (xlink != null) identifiers[count++] = new
SpecializedIdentifier<>(IdentifierSpace.XLINK, xlink);
+ identifiers = ArraysExt.resize(identifiers, count);
+ metadata = resolver.newIdentifiedObject(context, type,
identifiers);
+ }
+ } else {
+ // If principle, the XML should contain a full metadata object OR
a uuidref attribute.
+ // However if both are present, assign the identifiers to that
instance.
+ if (metadata instanceof IdentifiedObject) {
+ final IdentifierMap map = ((IdentifiedObject)
metadata).getIdentifierMap();
+ if (uuid != null) putInto(map, IdentifierSpace.UUID, uuid);
+ if (xlink != null) putInto(map, IdentifierSpace.XLINK, xlink);
+ }
+ }
+ return metadata;
+ }
+
+ /**
+ * Adds a new identifier into the given map. This method is a shortcut
which bypass the check
+ * for previous values associated to same the authority. It is okay only
when constructing
+ * new instances, for example at XML unmarshalling time.
+ *
+ * @param map The map in which to write the identifier.
+ * @param authority The identifier authority.
+ * @param value The identifier value, or {@code null} if not yet
defined.
+ */
+ private static <T> void putInto(final IdentifierMap map, final
IdentifierSpace<T> authority, final T value) {
+ if (map instanceof IdentifierMapAdapter) {
+ final SpecializedIdentifier<T> identifier = new
SpecializedIdentifier<>(authority, value);
+ /*
+ * If the following assert statement appears to fail in practice,
then remove
+ * completly this method and use the public putSpecialized(…)
method instead.
+ * Note: usage of 'put' is for having the compiler to check the
key type.
+ */
+ assert map.put(authority, null) == null : identifier;
+ ((IdentifierMapAdapter) map).identifiers.add(identifier);
+ } else {
+ map.putSpecialized(authority, value);
+ }
+ }
+}
Propchange:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/ObjectReference.java
------------------------------------------------------------------------------
svn:mime-type = text/plain;charset=UTF-8
Added:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java?rev=1458338&view=auto
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java
(added)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java
[UTF-8] Tue Mar 19 15:31:56 2013
@@ -0,0 +1,541 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.sis.internal.jaxb.gco;
+
+import java.util.UUID;
+import java.net.URI;
+import java.net.URISyntaxException;
+import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.adapters.XmlAdapter;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Type;
+import org.apache.sis.xml.XLink;
+import org.apache.sis.xml.NilObject;
+import org.apache.sis.xml.NilReason;
+import org.apache.sis.xml.Namespaces;
+import org.apache.sis.xml.IdentifierMap;
+import org.apache.sis.xml.IdentifierSpace;
+import org.apache.sis.xml.IdentifiedObject;
+import org.apache.sis.internal.jaxb.MarshalContext;
+import org.apache.sis.util.iso.SimpleInternationalString;
+
+
+/**
+ * Base class for adapters from GeoAPI interfaces to their SIS implementations.
+ * Implementation subclasses are actually both JAXB adapters and wrappers
around
+ * the value to be marshalled. Wrappers exist because ISO 19139 have the
strange
+ * habit to wrap every properties in an extra level, for example:
+ *
+ * {@preformat xml
+ * <CI_ResponsibleParty>
+ * <contactInfo>
+ * <CI_Contact>
+ * ...
+ * </CI_Contact>
+ * </contactInfo>
+ * </CI_ResponsibleParty>
+ * }
+ *
+ * The {@code </CI_Contact>} level is not really necessary, and JAXB is not
designed for inserting
+ * such level since it is not the usual way to write XML. In order to get this
output with JAXB,
+ * we have to wrap metadata object in an additional object. So each {@code
PropertyType} subclass
+ * is both a JAXB adapter and a wrapper. We have merged those functionalities
in order to avoid
+ * doubling the amount of classes, which is already large.
+ *
+ * <p>In ISO 19139 terminology:</p>
+ * <ul>
+ * <li>the public classes defined in the {@code org.apache.sis.metadata.iso}
packages are defined
+ * as {@code Foo_Type} in ISO 19139, where <var>Foo</var> is the ISO
name of a class.</li>
+ * <li>the {@code PropertyType} subclasses are defined as {@code
Foo_PropertyType} in
+ * ISO 19139 schemas.</li>
+ * </ul>
+ *
+ * @param <ValueType> The adapter subclass.
+ * @param <BoundType> The interface being adapted.
+ *
+ * @author Cédric Briançon (Geomatys)
+ * @author Martin Desruisseaux (Geomatys)
+ * @since 0.3 (derived from geotk-2.5)
+ * @version 0.3
+ * @module
+ *
+ * @see XmlAdapter
+ */
+public abstract class PropertyType<ValueType extends
PropertyType<ValueType,BoundType>, BoundType>
+ extends XmlAdapter<ValueType,BoundType>
+{
+ /**
+ * The wrapped GeoAPI metadata interface.
+ */
+ protected BoundType metadata;
+
+ /**
+ * Either an {@link ObjectReference} or a {@link String}.
+ *
+ * <ul>
+ * <li>{@link ObjectReference} defines the {@code idref}, {@code
uuidref}, {@code xlink:href},
+ * {@code xlink:role}, {@code xlink:arcrole}, {@code xlink:title},
{@code xlink:show} and
+ * {@code xlink:actuate} attributes.</li>
+ * <li>{@link String} defines the {@code nilReason} attribute.</li>
+ * </ul>
+ *
+ * Those two properties are exclusive (if the user defines an object
reference,
+ * then the attribute is not nil).
+ */
+ private Object reference;
+
+ /**
+ * Empty constructor for subclasses only.
+ */
+ protected PropertyType() {
+ }
+
+ /**
+ * Builds an adapter for the given GeoAPI interface.
+ *
+ * @param metadata The interface to wrap.
+ */
+ protected PropertyType(final BoundType metadata) {
+ this.metadata = metadata;
+ if (metadata instanceof IdentifiedObject) {
+ final IdentifierMap map = ((IdentifiedObject)
metadata).getIdentifierMap();
+ XLink link = map.getSpecialized(IdentifierSpace.XLINK);
+ UUID uuid = map.getSpecialized(IdentifierSpace.UUID);
+ String anyUUID = (uuid != null) ? uuid.toString() :
map.get(IdentifierSpace.UUID);
+ if (anyUUID != null || link != null) {
+ final MarshalContext context = MarshalContext.current();
+ if (uuid == null) {
+ uuid = ObjectReference.toUUID(context, anyUUID); // May
still null.
+ }
+ if (uuid == null ||
MarshalContext.resolver(context).canSubstituteByReference(context,
getBoundType(), metadata, uuid)) {
+ reference = new ObjectReference(uuid, anyUUID, link);
+ return;
+ }
+ }
+ }
+ if (metadata instanceof NilObject) {
+ final NilReason reason = ((NilObject) metadata).getNilReason();
+ if (reason != null) {
+ reference = reason.toString();
+ }
+ }
+ }
+
+ /**
+ * Returns the object reference, or {@code null} if none and the {@code
create} argument is {@code false}.
+ * If the {@code create} argument is {@code true}, then this method will
create the object reference when
+ * first needed. In the later case, any previous {@code gco:nilReason}
will be overwritten since
+ * the object is not nil.
+ */
+ private ObjectReference reference(final boolean create) {
+ final Object ref = reference;
+ if (ref instanceof ObjectReference) {
+ return (ObjectReference) ref;
+ } else if (create) {
+ final ObjectReference newRef = new ObjectReference();
+ reference = newRef;
+ return newRef;
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Returns the {@code xlink}, or {@code null} if none and {@code create}
is {@code false}.
+ * If the {@code create} argument is {@code true}, then this method will
create the XLink
+ * when first needed. In the later case, any previous {@code
gco:nilReason} will be
+ * overwritten since the object is not nil.
+ */
+ private XLink xlink(final boolean create) {
+ final ObjectReference ref = reference(create);
+ if (ref == null) {
+ return null;
+ }
+ XLink xlink = ref.xlink;
+ if (create && xlink == null) {
+ ref.xlink = xlink = new XLink();
+ xlink.setType(XLink.Type.SIMPLE); // The "simple" type is fixed in
the "gco" schema.
+ }
+ return xlink;
+ }
+
+ /**
+ * The reason why a mandatory attribute if left unspecified.
+ *
+ * @return the current value, or {@code null} if none.
+ * @category gco:PropertyType
+ */
+ @XmlAttribute(name = "nilReason", namespace = Namespaces.GCO)
+ public final String getNilReason() {
+ final Object ref = reference;
+ return (ref instanceof String) ? (String) ref : null;
+ }
+
+ /**
+ * Sets the {@code nilReason} attribute value. This method does nothing if
a
+ * non-null {@linkplaih #reference} exists, since in such case the object
can
+ * not be nil.
+ *
+ * @param nilReason The new attribute value.
+ * @category gco:PropertyType
+ */
+ public final void setNilReason(final String nilReason) {
+ if (!(reference instanceof ObjectReference)) {
+ reference = nilReason;
+ }
+ }
+
+ /**
+ * Returns {@code true} if the wrapped metadata should not be marshalled.
It may be because
+ * a non-null "{@code uuidref}" attribute has been specified (in which
case the UUID reference
+ * will be marshalled in place of the full metadata), or any other reason
that may be added in
+ * future implementations.
+ *
+ * @return {@code true} if the wrapped metadata should not be marshalled.
+ *
+ * @see #getElement()
+ */
+ protected final boolean skip() {
+ if (metadata instanceof NilObject) {
+ return true;
+ }
+ final Object ref = reference;
+ return (ref instanceof ObjectReference) && ((ObjectReference)
ref).anyUUID != null;
+ }
+
+ /**
+ * A URN to an external resources, or to an other part of a XML document,
or an identifier.
+ * The {@code uuidref} attribute is used to refer to an XML element that
has a corresponding
+ * {@code uuid} attribute.
+ *
+ * @return the current value, or {@code null} if none.
+ * @category gco:ObjectReference
+ */
+ @XmlAttribute(name = "uuidref", namespace = Namespaces.GCO)
+ public final String getUUIDREF() {
+ final ObjectReference ref = reference(false);
+ return (ref != null) ? ref.anyUUID : null;
+ }
+
+ /**
+ * Sets the {@code uuidref} attribute value.
+ *
+ * @param uuid The new attribute value.
+ * @category gco:ObjectReference
+ */
+ public final void setUUIDREF(final String uuid) {
+ reference(true).anyUUID = uuid;
+ }
+
+ /**
+ * Returns the given URI as a string, or returns {@code null} if the given
argument is null.
+ */
+ private static String toString(final Object uri) {
+ return (uri != null) ? uri.toString() : null;
+ }
+
+ /**
+ * Parses the given URI, or returns {@code null} if the given argument is
null or empty.
+ */
+ private static URI toURI(final String uri) throws URISyntaxException {
+ final MarshalContext context = MarshalContext.current();
+ return MarshalContext.converter(context).toURI(context, uri);
+ }
+
+ /**
+ * A URN to an external resources, or to an other part of a XML document,
or an identifier.
+ * The {@code idref} attribute allows an XML element to refer to another
XML element that
+ * has a corresponding {@code id} attribute.
+ *
+ * @return the current value, or {@code null} if none.
+ * @category xlink
+ */
+ @XmlAttribute(name = "href", namespace = Namespaces.XLINK)
+ public final String getHRef() {
+ final XLink link = xlink(false);
+ return (link != null) ? toString(link.getHRef()) : null;
+ }
+
+ /**
+ * Sets the {@code href} attribute value.
+ *
+ * @param href The new attribute value.
+ * @throws URISyntaxException If th given string can not be parsed as a
URI.
+ * @category xlink
+ */
+ public final void setHRef(final String href) throws URISyntaxException {
+ xlink(true).setHRef(toURI(href));
+ }
+
+ /**
+ * A URI reference for some description of the arc role.
+ *
+ * @return the current value, or {@code null} if none.
+ * @category xlink
+ */
+ @XmlAttribute(name = "role", namespace = Namespaces.XLINK)
+ public final String getRole() {
+ final XLink link = xlink(false);
+ return (link != null) ? toString(link.getRole()) : null;
+ }
+
+ /**
+ * Sets the {@code role} attribute value.
+ *
+ * @param role The new attribute value.
+ * @throws URISyntaxException If th given string can not be parsed as a
URI.
+ * @category xlink
+ */
+ public final void setRole(final String role) throws URISyntaxException {
+ xlink(true).setRole(toURI(role));
+ }
+
+ /**
+ * A URI reference for some description of the arc role.
+ *
+ * @return the current value, or {@code null} if none.
+ * @category xlink
+ */
+ @XmlAttribute(name = "arcrole", namespace = Namespaces.XLINK)
+ public final String getArcRole() {
+ final XLink link = xlink(false);
+ return (link != null) ? toString(link.getArcRole()) : null;
+ }
+
+ /**
+ * Sets the {@code arcrole} attribute value.
+ *
+ * @param arcrole The new attribute value.
+ * @throws URISyntaxException If th given string can not be parsed as a
URI.
+ * @category xlink
+ */
+ public final void setArcRole(final String arcrole) throws
URISyntaxException {
+ xlink(true).setArcRole(toURI(arcrole));
+ }
+
+ /**
+ * Just as with resources, this is simply a human-readable string with a
short description
+ * for the arc.
+ *
+ * @return the current value, or {@code null} if none.
+ * @category xlink
+ */
+ @XmlAttribute(name = "title", namespace = Namespaces.XLINK)
+ public final String getTitle() {
+ final XLink link = xlink(false);
+ return (link != null) ? toString(link.getTitle()) : null;
+ }
+
+ /**
+ * Sets the {@code title} attribute value.
+ *
+ * @param title The new attribute value.
+ * @category xlink
+ */
+ public final void setTitle(String title) {
+ if (title != null && !(title = title.trim()).isEmpty()) {
+ xlink(true).setTitle(new SimpleInternationalString(title));
+ }
+ }
+
+ /**
+ * Communicates the desired presentation of the ending resource on
traversal
+ * from the starting resource. It's value should be treated as follows:
+ *
+ * <ul>
+ * <li>new: load ending resource in a new window, frame, pane, or other
presentation context</li>
+ * <li>replace: load the resource in the same window, frame, pane, or
other presentation context</li>
+ * <li>embed: load ending resource in place of the presentation of the
starting resource</li>
+ * <li>other: behavior is unconstrained; examine other markup in the
link for hints</li>
+ * <li>none: behavior is unconstrained</li>
+ * </ul>
+ *
+ * @return the current value, or {@code null} if none.
+ * @category xlink
+ */
+ @XmlAttribute(name = "show", namespace = Namespaces.XLINK)
+ public final XLink.Show getShow() {
+ final XLink link = xlink(false);
+ return (link != null) ? link.getShow() : null;
+ }
+
+ /**
+ * Sets the {@code show} attribute value.
+ *
+ * @param show The new attribute value.
+ * @category xlink
+ */
+ public final void setShow(final XLink.Show show) {
+ xlink(true).setShow(show);
+ }
+
+ /**
+ * Communicates the desired timing of traversal from the starting resource
to the ending resource.
+ * It's value should be treated as follows:
+ *
+ * <ul>
+ * <li>onLoad: traverse to the ending resource immediately on loading
the starting resource</li>
+ * <li>onRequest: traverse from the starting resource to the ending
resource only on a post-loading event triggered for this purpose</li>
+ * <li>other: behavior is unconstrained; examine other markup in link
for hints</li>
+ * <li>none: behavior is unconstrained</li>
+ * </ul>
+ *
+ * @return the current value, or {@code null} if none.
+ * @category xlink
+ */
+ @XmlAttribute(name = "actuate", namespace = Namespaces.XLINK)
+ public final XLink.Actuate getActuate() {
+ final XLink link = xlink(false);
+ return (link != null) ? link.getActuate() : null;
+ }
+
+ /**
+ * Sets the {@code actuate} attribute value.
+ *
+ * @param actuate The new attribute value.
+ * @category xlink
+ */
+ public final void setActuate(final XLink.Actuate actuate) {
+ xlink(true).setActuate(actuate);
+ }
+
+ // Do NOT declare attributes xlink:label, xlink:from and xlink:to,
+ // because they are not part of the xlink:simpleLink group.
+
+
+ // ======== XmlAdapter methods
===============================================================
+
+
+ /**
+ * Returns the bound type, which is typically the GeoAPI interface. The
default implementation
+ * fetches the type using reflection, by looking at the second argument in
the parameterized
+ * types. However subclasses can override this method in order to return
directly the type,
+ * for type safety and performance reason.
+ *
+ * @return The bound type, which is typically the GeoAPI interface.
+ */
+ @SuppressWarnings("unchecked")
+ protected Class<BoundType> getBoundType() {
+ Class<?> classe = getClass();
+ do {
+ // Typically executed exactly once, but implemented as a loop
anyway as a
+ // safety in case we derive sub-classes from existing direct
sub-classes.
+ final Type type = classe.getGenericSuperclass();
+ if (type instanceof ParameterizedType) {
+ final ParameterizedType pt = (ParameterizedType) type;
+ if (pt.getRawType() == PropertyType.class) {
+ return (Class) pt.getActualTypeArguments()[1];
+ }
+ }
+ } while ((classe = classe.getSuperclass()) != null);
+ throw new AssertionError(getClass()); // Should never happen.
+ }
+
+ /**
+ * Creates a new instance of this class wrapping the given metadata.
+ * This method is invoked by {@link #marshal} after making sure that
+ * {@code value} is not null.
+ *
+ * @param value The GeoAPI interface to wrap.
+ * @return The adapter.
+ */
+ protected abstract ValueType wrap(final BoundType value);
+
+ /**
+ * Converts a GeoAPI interface to the appropriate adapter for the way it
will be
+ * marshalled into an XML file or stream. JAXB calls automatically this
method at
+ * marshalling time.
+ *
+ * @param value The bound type value, here the interface.
+ * @return The adapter for the given value.
+ */
+ @Override
+ public final ValueType marshal(final BoundType value) {
+ if (value == null) {
+ return null;
+ }
+ return wrap(value);
+ }
+
+ /**
+ * Converts an adapter read from an XML stream to the GeoAPI interface
which will
+ * contains this value. JAXB calls automatically this method at
unmarshalling time.
+ *
+ * @param value The adapter for a metadata value.
+ * @return An instance of the GeoAPI interface which represents the
metadata value.
+ * @throws URISyntaxException If a URI can not be parsed.
+ */
+ @Override
+ public final BoundType unmarshal(final ValueType value) throws
URISyntaxException {
+ return (value != null) ? value.resolve(MarshalContext.current()) :
null;
+ }
+
+ /**
+ * If the {@linkplain #metadata} is still null, tries to resolve it using
UUID, XLink
+ * or NilReason information. This method is invoked at unmarshalling time.
+ *
+ * @throws URISyntaxException If a URI can not be parsed.
+ * @throws IllegalArgumentException If the UUID can not be parsed.
+ */
+ final BoundType resolve(final MarshalContext context) throws
URISyntaxException, IllegalArgumentException {
+ final ObjectReference ref = reference(false);
+ if (ref != null) {
+ metadata = ref.resolve(context, getBoundType(), metadata);
+ }
+ if (metadata == null) {
+ final String value = getNilReason();
+ if (value != null) {
+ final NilReason nilReason =
MarshalContext.converter(context).toNilReason(context, value);
+ if (nilReason != null) {
+ metadata = nilReason.createNilObject(getBoundType());
+ }
+ }
+ }
+ return metadata;
+ }
+
+ /**
+ * Returns the SIS implementation class generated from the metadata value.
+ * The overriding method in subclasses will be systematically called at
marshalling time by JAXB.
+ *
+ * <p>The return value is usually an implementation of {@code BoundType}.
+ * But in some situations this is a Java type like {@link String}.
+ * For this raison the return type is declared as {@code Object} here,
+ * but subclasses shall restrict that to a more specific type.</p>
+ *
+ * <p>Typical implementation ({@code BoundType} and {@code ValueType} need
to be replaced
+ * by the concrete class):</p>
+ *
+ * {@preformat java
+ * @Override
+ * @XmlElementRef
+ * public BoundType getElement() {
+ * if (skip()) return null;
+ * final ValueType metadata = this.metadata;
+ * return (metadata instanceof BoundType) ? (BoundType) metadata :
new BoundType(metadata);
+ * }
+ * }
+ *
+ * The actual implementation may be slightly more complicated than the
above if there is
+ * various subclasses to check.
+ *
+ * @return The metadata to be marshalled.
+ *
+ * @see #skip()
+ */
+ public abstract Object getElement();
+}
Propchange:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/jaxb/gco/PropertyType.java
------------------------------------------------------------------------------
svn:mime-type = text/plain;charset=UTF-8
