JPA Documentation updates
This commit is contained in:
parent
37e2abb4e2
commit
64944d6d81
|
@ -87,6 +87,7 @@
|
||||||
<attach>false</attach>
|
<attach>false</attach>
|
||||||
<descriptors>
|
<descriptors>
|
||||||
<descriptor>${project.basedir}/src/assembly/hapi-fhir-all.xml</descriptor>
|
<descriptor>${project.basedir}/src/assembly/hapi-fhir-all.xml</descriptor>
|
||||||
|
<descriptor>${project.basedir}/src/assembly/hapi-fhir-jpaserver-example.xml</descriptor>
|
||||||
</descriptors>
|
</descriptors>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
|
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
|
||||||
|
|
||||||
<id>all</id>
|
<id>jpaserver-example</id>
|
||||||
|
|
||||||
<formats>
|
<formats>
|
||||||
<format>zip</format>
|
<format>zip</format>
|
||||||
|
@ -12,24 +12,13 @@
|
||||||
|
|
||||||
<fileSets>
|
<fileSets>
|
||||||
<fileSet>
|
<fileSet>
|
||||||
<directory>${project.basedir}</directory>
|
<directory>${project.basedir}/../hapi-fhir-jpaserver-example</directory>
|
||||||
<outputDirectory>/</outputDirectory>
|
<outputDirectory>/</outputDirectory>
|
||||||
<includes>
|
<includes>
|
||||||
<include>README*</include>
|
<include>pom.xml</include>
|
||||||
<include>LICENSE*</include>
|
<include>src/**</include>
|
||||||
<include>NOTICE*</include>
|
|
||||||
</includes>
|
</includes>
|
||||||
</fileSet>
|
</fileSet>
|
||||||
</fileSets>
|
</fileSets>
|
||||||
|
|
||||||
<dependencySets>
|
|
||||||
<dependencySet>
|
|
||||||
<outputDirectory>/lib</outputDirectory>
|
|
||||||
<useProjectArtifact>true</useProjectArtifact>
|
|
||||||
<unpack>false</unpack>
|
|
||||||
<scope>runtime</scope>
|
|
||||||
</dependencySet>
|
|
||||||
</dependencySets>
|
|
||||||
|
|
||||||
|
|
||||||
</assembly>
|
</assembly>
|
||||||
|
|
|
@ -0,0 +1,35 @@
|
||||||
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
|
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
|
||||||
|
|
||||||
|
<id>all</id>
|
||||||
|
|
||||||
|
<formats>
|
||||||
|
<format>zip</format>
|
||||||
|
<format>tar.bz2</format>
|
||||||
|
</formats>
|
||||||
|
|
||||||
|
<includeBaseDirectory>false</includeBaseDirectory>
|
||||||
|
|
||||||
|
<fileSets>
|
||||||
|
<fileSet>
|
||||||
|
<directory>${project.basedir}</directory>
|
||||||
|
<outputDirectory>/</outputDirectory>
|
||||||
|
<includes>
|
||||||
|
<include>README*</include>
|
||||||
|
<include>LICENSE*</include>
|
||||||
|
<include>NOTICE*</include>
|
||||||
|
</includes>
|
||||||
|
</fileSet>
|
||||||
|
</fileSets>
|
||||||
|
|
||||||
|
<dependencySets>
|
||||||
|
<dependencySet>
|
||||||
|
<outputDirectory>/lib</outputDirectory>
|
||||||
|
<useProjectArtifact>true</useProjectArtifact>
|
||||||
|
<unpack>false</unpack>
|
||||||
|
<scope>runtime</scope>
|
||||||
|
</dependencySet>
|
||||||
|
</dependencySets>
|
||||||
|
|
||||||
|
|
||||||
|
</assembly>
|
|
@ -3,6 +3,4 @@ encoding//src/main/java=UTF-8
|
||||||
encoding//src/main/resources=UTF-8
|
encoding//src/main/resources=UTF-8
|
||||||
encoding//src/test/java=UTF-8
|
encoding//src/test/java=UTF-8
|
||||||
encoding//src/test/resources=UTF-8
|
encoding//src/test/resources=UTF-8
|
||||||
encoding//target/generated-resources/tinder=UTF-8
|
|
||||||
encoding//target/generated-sources/tinder=UTF-8
|
|
||||||
encoding/<project>=UTF-8
|
encoding/<project>=UTF-8
|
||||||
|
|
|
@ -3,6 +3,4 @@ encoding//src/main/java=UTF-8
|
||||||
encoding//src/main/resources=UTF-8
|
encoding//src/main/resources=UTF-8
|
||||||
encoding//src/test/java=UTF-8
|
encoding//src/test/java=UTF-8
|
||||||
encoding//src/test/resources=UTF-8
|
encoding//src/test/resources=UTF-8
|
||||||
encoding//target/generated-resources/tinder=UTF-8
|
|
||||||
encoding//target/generated-sources/tinder=UTF-8
|
|
||||||
encoding/<project>=UTF-8
|
encoding/<project>=UTF-8
|
||||||
|
|
|
@ -81,6 +81,7 @@
|
||||||
<item name="Logging" href="./doc_logging.html" />
|
<item name="Logging" href="./doc_logging.html" />
|
||||||
<item name="ETags" href="./doc_rest_etag.html" />
|
<item name="ETags" href="./doc_rest_etag.html" />
|
||||||
<item name="Tinder Plugin" href="./doc_tinder.html" />
|
<item name="Tinder Plugin" href="./doc_tinder.html" />
|
||||||
|
<item name="JPA/Database Server" href="./doc_jpa.html" />
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu name="Community">
|
<menu name="Community">
|
||||||
|
@ -89,10 +90,14 @@
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu name="JavaDocs">
|
<menu name="JavaDocs">
|
||||||
<item name="Core API" href="./apidocs/index.html" />
|
<item name="Core API" href="./apidocs/index.html">
|
||||||
|
<item name="Source Code" href="https://github.com/jamesagnew/hapi-fhir" />
|
||||||
|
</item>
|
||||||
<item name="Model API (DSTU1)" href="./apidocs-dstu/index.html" />
|
<item name="Model API (DSTU1)" href="./apidocs-dstu/index.html" />
|
||||||
<item name="Model API (DEV)" href="./apidocs-dev/index.html" />
|
<item name="Model API (DEV)" href="./apidocs-dev/index.html" />
|
||||||
<item name="Source Code" href=".https://github.com/jamesagnew/hapi-fhir" />
|
<item name="JPA Server API" href="./apidocs-jpaserver/index.html">
|
||||||
|
<item name="Source Code" href="./xref-jpaserver/index.html" />
|
||||||
|
</item>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu name="Reports">
|
<menu name="Reports">
|
||||||
|
|
|
@ -0,0 +1,40 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<title>JPA Server - HAPI FHIR</title>
|
||||||
|
<author email="jamesagnew@users.sourceforge.net">James Agnew</author>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<section name="JPA Server">
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The HAPI FHIR
|
||||||
|
<a href="./doc_rest_server.html">RestfulServer</a>
|
||||||
|
module can be used to create a FHIR server endpoint against an arbitrary
|
||||||
|
data source, which could be a database of your own design, an existing
|
||||||
|
clinical system, a set of files, or anything else you come up with.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
HAPI also provides a specific database implementation which can be used to
|
||||||
|
provide a complete RESTful server implementation, backed by a database.
|
||||||
|
HAPI FHIR's JPA module is an implementation of a database storage layer, using
|
||||||
|
the JPA 2.0 API with Hibernate as the recommended implementation.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Important Note: </b>
|
||||||
|
This implementation uses a fairly simple table design, with a
|
||||||
|
single table being used to hold resource bodies (which are stored as
|
||||||
|
GZipped CLOBs) and a set of tables to hold search indexes, tags,
|
||||||
|
history details, etc. This design is only one of many possible ways
|
||||||
|
of designing a FHIR server so it is worth considering whether it
|
||||||
|
is appropriate for the problem you are trying to solve.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</document>
|
Loading…
Reference in New Issue