onami-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1444394 - in /incubator/onami/sandbox/converters/src: ./ site/ site/apt/
Date Sat, 09 Feb 2013 16:45:10 GMT
Author: simonetripodi
Date: Sat Feb  9 16:45:09 2013
New Revision: 1444394

URL: http://svn.apache.org/r1444394
Log:
[ONAMI-76] added converters documentation importing it from [configuration] module

Added:
    incubator/onami/sandbox/converters/src/
    incubator/onami/sandbox/converters/src/site/
    incubator/onami/sandbox/converters/src/site/apt/
    incubator/onami/sandbox/converters/src/site/apt/all.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/format.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/index.apt   (with props)
    incubator/onami/sandbox/converters/src/site/apt/net.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/apt/system.apt.vm   (with props)
    incubator/onami/sandbox/converters/src/site/site.xml   (with props)

Added: incubator/onami/sandbox/converters/src/site/apt/all.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/all.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/all.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/all.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,40 @@
+   ------
+   Apache Onami Converters | All
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - All
+
+  The <<All>> module is a special module that contains all <<<${project.groupId}>>>
converters implementations.
+
+  Users that want to use the <All> module, have to add the following dependency in
the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.all</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+

Propchange: incubator/onami/sandbox/converters/src/site/apt/all.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/all.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/all.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,62 @@
+   ------
+   Apache Onami Converters | Extend
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Extend Apache Onami Converters
+
+  Users that have the need to integrate not already implemented converters,
+  can easily do it by following the listed steps:
+
+  [[1]] add the <<<core>>> dependency in the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.core</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+  [[2]] Extend the <<<org.apache.onami.converters.core.AbstractConverter>>>,
+        that's the class responsible for the conversion and self-binding, specifying the
converted type:
+
++--------------------------------------+
+public final class DecimalFormatConverter
+    extends AbstractConverter<DecimalFormat>
+{
+
+    /**
+     * {@inheritDoc}
+     */
+    public Object convert( String value, TypeLiteral<?> toType )
+    {
+        return new DecimalFormat( value );
+    }
+
+}
++--------------------------------------+
+
+  [[3]] Plug your new logging module and enjoy ;)

Propchange: incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/extend.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/format.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/format.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/format.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/format.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,52 @@
+   ------
+   Apache Onami Converters | Format
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - Format
+
+  The <<Format>> module contains <<<java.text.XXXFormat>>>
converters implementations.
+
+  Users that want to use the <Format> module, have to add the following dependency
in the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.format</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+* The Converters
+
+** DecimalFormatConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.text.DecimalFormat>>>
+
+** SimpleDateFormatConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.text.SimpleDateFormat>>>
\ No newline at end of file

Propchange: incubator/onami/sandbox/converters/src/site/apt/format.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/format.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/format.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,101 @@
+   ------
+   Apache Onami Converters | i18n
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - i18n
+
+  The <<i18n>> module contains useful i18n converters implementations.
+
+  Users that want to use the <Format> module, have to add the following dependency
in the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.i18n</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+* The Converters
+
+** CurrencyConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.Currency>>>.
+
+** DateConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.Calendar>>> and to <<<java.util.Date>>>.
+
+  By default, this converter manages the following ISO Date format representation:
+
+  * yyyy;
+
+  * yyyy-MM;
+
+  * yyyy-MM-dd;
+
+  * yyyy-MM-dd'T'hh:mmZ;
+
+  * yyyy-MM-dd'T'hh:mm:ssZ;
+
+  * yyyy-MM-dd'T'hh:mm:ss.sZ
+
+  If users need to add new supported date formats, first they have to retrieve
+  the <DateConverter>, then add a new pattern:
+
++--------------------------------------+
+DateConverter dateConverter = module.lookup( Date.class, DateConverter.class );
+dateConverter.addPattern( "EEE, MMM d, ''yy" );
++--------------------------------------+
+
+  If users need to set the <<<java.util.Locale>>> and/or the
+  <<<java.util.TimeZone>>>, first they have to retrieve the <DateConverter>,
+  then set their preferences:
+
++--------------------------------------+
+import java.util.Locale;
+import java.util.TimeZone;
+...
+DateConverter dateConverter = module.lookup( Date.class, DateConverter.class );
+dateConverter.setLocale( Locale.getDefault() );
+dateConverter.setTimeZone( TimeZone.getDefault() );
++--------------------------------------+
+
+** LocaleConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.Locale>>>
+
+  The converter checks first if the input String matches with the pattern
+  <languageCode_counrtyCode> to create the <<<java.util.Locale>>>
otherwise
+  will use the input value as Locale language.
+
+** TimeZoneConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.TimeZone>>>.

Propchange: incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/i18n.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/index.apt?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/index.apt (added)
+++ incubator/onami/sandbox/converters/src/site/apt/index.apt Sat Feb  9 16:45:09 2013
@@ -0,0 +1,76 @@
+   ------
+   Introduction to Apache Onami Converters
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Introduction
+
+  <<Apache Onami Converters>> is a set of {{{http://google-guice.googlecode.com/git/javadoc/com/google/inject/spi/TypeConverter.html}com.google.inject.spi.TypeConverter}}
+  implementation not already present in Guice, such as:
+
+ * {{{./format.html}Format converters}};
+
+ * {{{./i18n.html}i18n converters}};
+
+ * {{{./net.html}Net converters}};
+
+ * {{{./numbers.html}Numbers converters}};
+
+ * {{{./sql.html}SQL converters}};
+
+ * {{{./system.html}System converters}};
+
+ * {{{./complete.html}The complete converters module}};
+
+ * {{{./extend.html}Extend Onami Converters}}.
+
+  Each converter is implemented as a self-binding module to be easy installed in the <<<Injector>>>
as shown below:
+
++--------------------------------------+
+import static com.google.inject.Guice.createInjector;
+import static com.google.inject.name.Names.named;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Injector;
+
+...
+
+Injector injector = createInjector( new XXXConverter(),
+                                    new YYYConverter(),
+                                    new AbstractModule()
+                                    {
+
+                                        @Override
+                                        protected void configure()
+                                        {
+                                            bindConstant()
+                                            .annotatedWith( named( "charset" ) )
+                                            .to( "UTF-8" );
+                                        }
+
+                                    }
+);
++--------------------------------------+
+
+  Moreover, each converter can be discovered by the {{{http://en.wikipedia.org/wiki/Service_provider_interface}Service
provider interface}}

Propchange: incubator/onami/sandbox/converters/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/net.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/net.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/net.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/net.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,72 @@
+   ------
+   Apache Onami Converters | Net
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - Net
+
+  The <<Net>> module contains <<<java.net>>> converters implementations.
+
+  Users that want to use the <Format> module, have to add the following dependency
in the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.net</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+* The Converters
+
+** InetAddressConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.net.InetAddress>>>
+
+** URIConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.net.URI>>>.
+
+** URLConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.net.URL>>>, supporting the <classpath://> pseudo protocol,
to load
+  resources from the the class path.
+
+  Users that need to load classpath resources, have to specify the full qualified
+  name of the resource. For example, given the class path resource:
+
++--------------------------------------+
+com.acme.myapplication.JDBC.properties
++--------------------------------------+
+
+  following URLs point to the same resource:
+
++--------------------------------------+
+classpath://com/acme/myapplication/JDBC.properties
+classpath:///com/acme/myapplication/JDBC.properties
++--------------------------------------+

Propchange: incubator/onami/sandbox/converters/src/site/apt/net.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/net.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/net.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,52 @@
+   ------
+   Apache Onami Converters | Numbers
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - Numbers
+
+  The <<Numbers>> module contains <<<java.math>>> converters
implementations.
+
+  Users that want to use the <Format> module, have to add the following dependency
in the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.numbers</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+* The Converters
+
+** BigDecimalConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.math.BigDecimal>>>.
+
+** BigIntegerConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.math.BigInteger>>>.

Propchange: incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/numbers.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,62 @@
+   ------
+   Apache Onami Converters | SQL
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - SQL
+
+  The <<SQL>> module contains <<<java.sql>>> converters implementations.
+
+  Users that want to use the <SQL> module, have to add the following dependency in
the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.sql</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+* The Converters
+
+** ClobConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.sql.Clob>>>.
+
+** SQLDateConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.sql.Date>>>, input has to match with <<<yyyy-MM-dd>>>
pattern.
+
+** SQLTimeConverter.java
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.sql.Time>>>, input has to match with <<<HH:mm:ss>>>
pattern.
+
+** SQLTimestampConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.sql.Timestamp>>>, input has to match with <<<yyyy-MM-dd
HH:mm:ss.fffffffff>>> pattern.

Propchange: incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/sql.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/apt/system.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/apt/system.apt.vm?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/apt/system.apt.vm (added)
+++ incubator/onami/sandbox/converters/src/site/apt/system.apt.vm Sat Feb  9 16:45:09 2013
@@ -0,0 +1,87 @@
+   ------
+   Apache Onami Converters | System
+   ------
+   The Apache Onami Team
+   ------
+   2013
+
+~~
+~~ 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.
+~~
+
+Apache Onami Converters - System
+
+  The <<System>> module contains generic system java converters implementations.
+
+  Users that want to use the <System> module, have to add the following dependency
in the <<<pom.xml>>>:
+
++--------------------------------------+
+<dependency>
+  <groupId>${project.groupId}</groupId>
+  <artifactId>${project.groupId}.system</artifactId>
+  <version>${project.version}</version>
+  <scope>compile</scope>
+</dependency>
++--------------------------------------+
+
+* The Converters
+
+** BitSetConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.BitSet>>>.
+
+  String representation is typically a CSV String mixed o chars and numbers, i.e:
+
++--------------------------------------+
+a, 123, ~
++--------------------------------------+
+
+  in the example, <<<a>>> is taken in consideration as a <<<char>>>,
<<<123>>>
+  as an <<<int>>>, <<<~>>> as a <<<char>>>.
+
+  <<Note>> non numerical fragments with length great than 1 are not allowed!!!
+
+** CharsetConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.nio.charset.Charset>>>.
+
+** FileConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.io.File>>>
+
+** PatternConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.regex.Pattern>>>
+
+** PropertiesConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.Properties>>>
+
+  <<Note>> Input string has to match with the pattern <key1=value1\nkey2=value2...>
+  encoded using the <<<ISO-8859-1>>> charset, according to <<<java.util.Properties>>>
+  recommendation.
+
+** UUIDConverter
+
+  Is the converter that converts a <<<java.lang.String>>> representation
to a
+  <<<java.util.UUID>>>.

Propchange: incubator/onami/sandbox/converters/src/site/apt/system.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/apt/system.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/sandbox/converters/src/site/apt/system.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/sandbox/converters/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/onami/sandbox/converters/src/site/site.xml?rev=1444394&view=auto
==============================================================================
--- incubator/onami/sandbox/converters/src/site/site.xml (added)
+++ incubator/onami/sandbox/converters/src/site/site.xml Sat Feb  9 16:45:09 2013
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ | 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.
+-->
+<project xmlns="http://maven.apache.org/DECORATION/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/DECORATION/1.1.0 http://maven.apache.org/xsd/decoration-1.1.0.xsd"
+  name="${project.name}">
+
+  <body>
+    <head>
+      <link rel="meta" title="DOAP" href="${project.url}/doap.rdf" type="application/rdf+xml"
/>
+    </head>
+
+    <menu name="Apache Onami™ Converters">
+      <item name="Home" href="./index.html" />
+      <item name="Format converters" href="./format.html" />
+      <item name="i18n converters" href="./i18n.html" />
+      <item name="Net converters" href="./net.html" />
+      <item name="Numbers converters" href="./numbers.html" />
+      <item name="SQL converters" href="./sql.html" />
+      <item name="System converters" href="./system.html" />
+      <item name="The complete converters module" href="./all.html" />
+      <item name="Extend Onami Converters" href="./extend.html" />
+    </menu>
+
+    <menu ref="reports"/>
+
+    <footer>
+      <div class="row span12">
+        Apache Onami, Apache Onami Configuration, Apache, the Apache feather logo, and the
Apache Onami project logos are trademarks of The Apache Software Foundation. All other marks
mentioned may be trademarks or registered trademarks of their respective owners.
+      </div>
+    </footer>
+  </body>
+
+</project>

Propchange: incubator/onami/sandbox/converters/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/sandbox/converters/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/onami/sandbox/converters/src/site/site.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml



Mime
View raw message