sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1506953 - in /sis/site/trunk: content/faq.mdtext templates/skeleton.html
Date Thu, 25 Jul 2013 13:09:15 GMT
Author: desruisseaux
Date: Thu Jul 25 13:09:15 2013
New Revision: 1506953

URL: http://svn.apache.org/r1506953
Log:
Ported FAQ from APT pages.

Added:
    sis/site/trunk/content/faq.mdtext
      - copied, changed from r1506743, sis/branches/JDK7/core/sis-metadata/src/site/fml/faq.fml
Modified:
    sis/site/trunk/templates/skeleton.html

Copied: sis/site/trunk/content/faq.mdtext (from r1506743, sis/branches/JDK7/core/sis-metadata/src/site/fml/faq.fml)
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/faq.mdtext?p2=sis/site/trunk/content/faq.mdtext&p1=sis/branches/JDK7/core/sis-metadata/src/site/fml/faq.fml&r1=1506743&r2=1506953&rev=1506953&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/site/fml/faq.fml (original)
+++ sis/site/trunk/content/faq.mdtext Thu Jul 25 13:09:15 2013
@@ -1,73 +1,83 @@
-<?xml version="1.0" encoding="UTF-8"?>
+Title:  Frequently asked questions
+Notice: 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.
 
-<!--
-  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.
--->
-
-<faqs xmlns="http://maven.apache.org/FML/1.0.1"
-      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-      xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
-      title="Metadata FAQ" toplink="false">
-  <part id="implementation">
-    <title>Custom implementations</title>
-    <faq id="proxy">
-      <question>
-        My metadata are stored in a database-like framework.
-        Implementing every GeoAPI interfaces for accessing them is impratical.
-      </question>
-      <answer>
-        <p>Developers do not need to implement directly the metadata interfaces.
-        If the underlying storage framework allows access to metadata from their class and
attribute names
-        (either Java names or ISO/OGC names), then it is possible to implement a single engine
accessing
-        any kind of metadata and let the Java Virtual Machine implements the GeoAPI interfaces
on-the-fly, using the
-        <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Proxy.html">java.lang.reflect.Proxy</a></code>
-        class. See the <code>Proxy</code> Javadoc for details, keeping in mind
that the ISO/OGC name
-        of a <code>java.lang.Class</code> or <code>java.lang.reflect.Method</code>
object can be
-        obtained as below:</p>
-
-<blockquote><pre>UML uml = method.getAnnotation(UML.class);
-if (uml != null) {
-    String name = uml.identifier();
-    // Fetch the metadata here.
-}</pre></blockquote>
-
-        <p>This is exactly the approach taken by the <code>org.apache.sis.metadata.sql</code>
package
-        for providing an implementation of all GeoAPI metadata interfaces reading their values
-        directly from a SQL database.</p>
-      </answer>
-    </faq>
-    <faq id="unknownClass">
-      <question>
-        I can't marshall my custom implementation (<code>JAXBException</code>)
-      </question>
-      <answer>
-        <p>The classes given to the JAXB marshaller must contain JAXB annotations,
-        otherwise the following exception is thrown:</p>
-
-        <blockquote><code>javax.xml.bind.JAXBException:</code> class <cite>MyCustomClass</cite>
-        nor any of its super class is known to this context.</blockquote>
-
-        <p>The easiest workaround is to wrap the custom implementation into one of
the implementations
-        provided in the <code>org.apache.metadata.iso</code> package. All those
SIS implementation
-        classes provide shallow copy constructor for making that easy. Note that you need
to wrap
-        only the root class, not the attributes. The attribute values will be wrapped automatically
-        as needed by JAXB adapters.</p>
-      </answer>
-    </faq>
-  </part>
-</faqs>
+
+This page lists some Frequently Asked Questions (FAQ) when using Apache SIS.
+
+[TOC]
+
+
+
+Metadata    {#metadata}
+=======================
+
+Frequently asked questions about the `sis-metadata` module.
+
+Custom implementations    {#metadata-implementation}
+----------------------------------------------------
+
+Frequently asked questions custom implementations of `org.opengis.metadata` interfaces.
+
+
+
+### My metadata are stored in a database-like framework. Implementing every GeoAPI interfaces
for them is impractical.    {#metadata-proxy}
+
+Developers do not need to implement directly the metadata interfaces.
+If the underlying storage framework can access metadata from their class and attribute names
(either Java names
+or ISO/OGC names), then it is possible to implement a single engine accessing any kind of
metadata and let the
+Java Virtual Machine implements the GeoAPI interfaces on-the-fly, using the `java.lang.reflect.Proxy`
class.
+See the `Proxy` Javadoc for details, keeping in mind that the ISO/OGC name of a `java.lang.Class`
or
+`java.lang.reflect.Method` object can be obtained as below:
+
+    :::java
+    UML uml = method.getAnnotation(UML.class);
+    if (uml != null) {
+        String name = uml.identifier();
+        // Fetch the metadata here.
+    }
+
+This is indeed the approach taken by the `org.apache.sis.metadata.sql` package for providing
an implementation
+of all GeoAPI metadata interfaces reading their values directly from a SQL database.
+
+
+
+### I can't marshall my custom implementation (`JAXBException`).    {#metadata-unknownClass"}
+
+The classes given to the JAXB marshaller shall contain JAXB annotations,
+otherwise the following exception is thrown:
+
+    :::text
+    javax.xml.bind.JAXBException: class MyCustomClass
+    nor any of its super class is known to this context.
+
+The easiest workaround is to wrap the custom implementation into one of the implementations
+provided in the `org.apache.metadata.iso` package.
+All those SIS implementation classes provide shallow copy constructor for making that easy.
+Note that you need to wrap only the root class, not the attributes.
+The attribute values will be wrapped automatically as needed by JAXB adapters.
+
+
+
+Referencing    {#referencing}
+=============================
+
+Frequently asked questions about the `sis-referencing` module.
+
+### Axis order    {#axisOrder}
+
+(... to be provided later ...)

Modified: sis/site/trunk/templates/skeleton.html
URL: http://svn.apache.org/viewvc/sis/site/trunk/templates/skeleton.html?rev=1506953&r1=1506952&r2=1506953&view=diff
==============================================================================
--- sis/site/trunk/templates/skeleton.html (original)
+++ sis/site/trunk/templates/skeleton.html Thu Jul 25 13:09:15 2013
@@ -36,6 +36,7 @@
                   <li><a href="source.html">Source Code</a></li>
                   <li><a href="code-patterns.html">Code patterns</a></li>
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue
Tracker</a></li>
+                  <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
                 </ul>
               </li>
@@ -68,6 +69,7 @@
               <li><a href="source.html">Source Code</a></li>
               <li><a href="code-patterns.html">Code patterns</a></li>
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
+              <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
               <li class="nav-header">ASF</li>
               <li><a href="http://www.apache.org">The Foundation</a></li>



Mime
View raw message