Skip to content

Commit

Permalink
Added draft 1 of asciidocs (#343)
Browse files Browse the repository at this point in the history
* Added draft 1 of asciidocs
* Added exclude to docs for license
  • Loading branch information
garethahealy authored May 4, 2017
1 parent 439d633 commit 58ccecf
Show file tree
Hide file tree
Showing 115 changed files with 5,981 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/asciidoc/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Dozer

== What is Dozer?
Dozer is a Java Bean to Java Bean mapper that recursively copies data
from one object to another. Typically, these Java Beans will be of
different complex types.

Dozer supports simple property mapping, complex type mapping,
bi-directional mapping, implicit-explicit mapping, as well as recursive
mapping. This includes mapping collection attributes that also need
mapping at the element level.

Please read the link:about/about.adoc[about] page for detailed
information on Dozer.
75 changes: 75 additions & 0 deletions docs/asciidoc/SUMMARY.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
= Summary

== News
.. link:about/news.adoc[News]
... link:about/archived-news.adoc[Archived News]

== About
.. link:about/about.adoc[About]
.. link:about/downloading.adoc[Downloading]
.. link:about/license.adoc[License]

== User Guide
.. link:documentation/whymap.adoc[Why Map?]
.. link:documentation/gettingstarted.adoc[Getting Started]
... link:documentation/dependencies.adoc[Dependencies]
.. link:documentation/usage.adoc[Usage]
.. link:documentation/annotations.adoc[Mappings via Annotations]
.. link:documentation/apimappings.adoc[Mappings via API]
.. link:documentation/mappings.adoc[Mappings via XML]
.. link:documentation/configuration/configuration.adoc[Configuration]
.. link:documentation/configuration/logging.adoc[Logging]
.. link:documentation/configuration/statistics.adoc[Statistics]
.. link:documentation/jmxintegration.adoc[JMX Integration]
.. link:documentation/springintegration.adoc[Spring Integration]
.. link:documentation/xmlbeans.adoc[JAXB and XMLBeans]
.. link:documentation/metadata.adoc[Metadata Query Interface]
.. link:documentation/faq.adoc[FAQ]

todo

.. link:documentation/advancedConfiguration.adoc[advancedConfiguration]
.. link:documentation/advancedproperty.adoc[advancedproperty]
.. link:documentation/baseattributes.adoc[baseattributes]
.. link:documentation/collectionandarraymapping.adoc[collectionandarraymapping]
.. link:documentation/contextmapping.adoc[contextmapping]
.. link:documentation/copybyreference.adoc[copybyreference]
.. link:documentation/custombeanfactories.adoc[custombeanfactories]
.. link:documentation/customconverter.adoc[customconverter]
.. link:documentation/customCreateMethod.adoc[customCreateMethod]
.. link:documentation/custommethods.adoc[custommethods]
.. link:documentation/deepmapping.adoc[deepmapping]
.. link:documentation/enum.adoc[enum]
.. link:documentation/events.adoc[events]
.. link:documentation/exclude.adoc[exclude]
.. link:documentation/expressionlanguage.adoc[expressionlanguage]
.. link:documentation/globalConfiguration.adoc[globalConfiguration]
.. link:documentation/indexmapping.adoc[indexmapping]
.. link:documentation/mapbackedproperty.adoc[mapbackedproperty]
.. link:documentation/mappingclasses.adoc[mappingclasses]
.. link:documentation/oneway.adoc[oneway]
.. link:documentation/proxyhandling.adoc[proxyhandling]
.. link:documentation/simpleproperty.adoc[simpleproperty]
.. link:documentation/stringtodatemapping.adoc[stringtodatemapping]
.. link:documentation/examples.adoc[examples]

== Schema
.. schema/beanmapping.xsd[Dozer Mapping XSD]
.. dozer-user-guide.pdf[User's Guide PDF]

== Eclipse Plugin
.. link:documentation/eclipse-plugin/installation.adoc[Installation]
.. link:documentation/eclipse-plugin/usage.adoc[Usage]
... link:documentation/eclipse-plugin/usage-xml.adoc[via XML]
... link:documentation/eclipse-plugin/usage-editor.adoc[via Editor]

== Community
.. link:community/articles.adoc[Articles]
.. link:community/support.adoc[Support]
.. link:community/team-list.adoc[Team List]
.. link:community/issue-tracking.adoc[Issue Tracking]
.. link:community/source-repository.adoc[Source Repository]

== Release Notes
.. link:releasenotes/releasenotes.adoc[Release Notes]
... link:releasenotes/archived-releasenotes.adoc[Archived Release Notes]
40 changes: 40 additions & 0 deletions docs/asciidoc/about/about.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
== About
Dozer is a Java Bean to Java Bean mapper that recursively copies data
from one object to another. Typically, these Java Beans will be of
different complex types.

Dozer supports simple property mapping, complex type mapping,
bi-directional mapping, implicit-explicit mapping, as well as recursive
mapping. This includes mapping collection attributes that also need
mapping at the element level.

Dozer not only supports mapping between attribute names, but also
automatically converting between types. Most conversion scenarios are
supported out of the box, but Dozer also allows you to specify custom
conversions via XML.

The mapper is used any time you need to take one type of Java Bean and
map it to another type of Java Bean. Most field mapping can be done
automatically by Dozer using reflection, but any custom mapping can be
predescribed in XML format. Mapping is bi-directional so only one
relationship between classes needs defining. If any property names on
both objects are the same you do not even need to do any explicit
property mapping for these fields.

The picture below depicts some of the common areas Dozer could be
inserted into an architecture. Notice that it typically is utilized at
the boundaries (entry/exit). Dozer will make sure that your internal
domain objects from the database do not bleed into external presentation
layers or to external consumers. It can also help map your domain
objects to external APIs calls and vice-versa.

image:../images/architecture.gif[architecture]

The bean mapper is written in Java and relies heavily on the Jakarta
Commons Bean Utils package for Java Bean utility methods.

=== Why Map?
Please read the link:../documentation/whymap.adoc[Why Map?] page.

=== Frequently Asked Questions
Please read the link:../documentation/faq.adoc[FAQ] page.
Loading

0 comments on commit 58ccecf

Please sign in to comment.