Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
71 changed files
with
19,483 additions
and
19,483 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,156 +1,156 @@ | ||
| What is Frames-OrientDB Plugin ? | ||
| ============ | ||
|
|
||
| **Frames-OrientDB plugin** is a Java O/G mapper for the [OrientDB](http://www.orientdb.org/) with the [Play! framework](http://www.playframework.org/) 2. It is used with the [TinkerPop Frames](https://github.com/tinkerpop/frames/wiki) for O/G mapping. | ||
|
|
||
| Features | ||
| ====== | ||
|
|
||
| * Object-Graph-Mapping by the [TinkerPop Frames](https://github.com/tinkerpop/frames/wiki) | ||
|
|
||
| * Support for both the embedded OrientDB and remote OrientDB | ||
|
|
||
| * Auto-reloading support | ||
|
|
||
| * Custom vertex and edge types support [(sample)](samples/frames-simple-app-with-custom-types) | ||
| * Note that Custom types, Constraints and Indexes are not yet implemented. | ||
|
|
||
| * Support to enable to customize the format of Model Id ([src](app/com/wingnest/play2/frames/plugin/orientdb/CustomIdManager.java)) | ||
|
|
||
| * On only embedded OrienDB: | ||
|
|
||
| * Support to enable to use the [OrientDB Studio](https://github.com/nuvolabase/orientdb/wiki/OrientDB-Studio) | ||
|
|
||
| Requirements | ||
| ========= | ||
|
|
||
| * Java 5 or 6, 7 | ||
| * Play 2.2 | ||
|
|
||
| Dependencies | ||
| ============ | ||
|
|
||
| * OrientDB 1.5.1 | ||
|
|
||
| Install | ||
| ==== | ||
|
|
||
| 1) Install Play framework 2.2 | ||
|
|
||
| 2) Executing the command for installing the [TinkerPop Frames Module](http://goo.gl/0g43T) | ||
|
|
||
| % git clone git@github.com:sgougi/play21-frames-module.git | ||
| % cd play21-frames-module | ||
| % git checkout 2.4.3 | ||
|
|
||
| 3) Publishing the Frames Module to your local repository | ||
|
|
||
| % cd play21-frames-module | ||
| % play publish-local | ||
|
|
||
| 4) Executing the command for installing the Frames-OrientDB Plugin | ||
|
|
||
| % git clone git@github.com:sgougi/play21-frames-orientdb-plugin.git | ||
| 5) Publishing the Frames-OrientDB Plugin to your local repository | ||
|
|
||
| % cd play21-frames-orientdb-plugin | ||
| % play publish-local | ||
|
|
||
|
|
||
| Run sample application | ||
| ======================= | ||
|
|
||
| At a command prompt, type the following commands: | ||
|
|
||
| % cd play21-frames-orientdb-plugin | ||
| % cd samples | ||
| % cd frames-simple-app | ||
| % play run | ||
|
|
||
| There are basic usage in the source code of a [sample application](samples). | ||
|
|
||
| * [Annotated model classes](samples/frames-simple-app/app/models) | ||
| * [Creating a key index](samples/frames-simple-app/app/Global.java) | ||
| * [Application configuration: conf/application.conf](samples/frames-simple-app/conf/application.conf) | ||
| * [Dependency settings: project/Build.scala](samples/frames-simple-app/project/Build.scala) | ||
| * [Controller with transaction](samples/frames-simple-app/app/controllers/Application.java) | ||
|
|
||
| ## Facade Classes for GraphDB | ||
|
|
||
| The com.wingnest.play2.frames.[GraphDB](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/GraphDB.java) class is a Facade class. | ||
|
|
||
| * GraphDB.commit() | ||
| * GraphDB.rollback() | ||
| * GraphDB.getGraph() | ||
| * GraphDB.createFramedGraph() | ||
| * GraphDB.getGraphManager() | ||
| * GraphDB.createKeyIndex() | ||
| * GraphDB.dropKeyIndex() | ||
| * GraphDB.createIndex() | ||
| * GraphDB.dropIndex() | ||
| * GraphDB.getIndexedKeys() | ||
| * GraphDB.getIndex() | ||
| * GraphDB.getIndices() | ||
|
|
||
| The com.wingnest.play2.frames.[OrientDB] (app/com/wingnest/play2/frames/OrientDB.java) class is a Facade class. | ||
|
|
||
| * OrientDB.fromCustomIdToORID() | ||
| * OrientDB.fromORIDToCustomId() | ||
| * OrientDB.setCustomIdHandler() | ||
|
|
||
| ## Extended Annotations | ||
|
|
||
| ### For Models | ||
| ####[@Id](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/annotations/Id.java) | ||
| Defines one attribute as id attribute. | ||
|
|
||
| ex: | ||
|
|
||
| public interface A { | ||
| ... | ||
| @Id | ||
| public Object getId(); | ||
| ... | ||
| } | ||
| ####[@CustomId](app/com/wingnest/play2/frames/annotations/CustomId.java) | ||
| Defines one attribute as custom id attribute. (ref:([CustomIdManager](app/com/wingnest/play2/frames/plugin/orientdb/CustomIdManager.java))) | ||
|
|
||
| ex: | ||
|
|
||
| public interface A { | ||
| ... | ||
| @CustomId | ||
| public Object getCustomId(); | ||
| ... | ||
| } | ||
|
|
||
| ####[@IndexedProperty](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/annotations/IndexedProperty.java) | ||
| Defines one or more attributes as indexed attribute. | ||
|
|
||
| ex: | ||
|
|
||
| public interface A { | ||
| ... | ||
| @IndexedProperty("type") | ||
| public String getType(); | ||
| @IndexedProperty("type") | ||
| public void setType(String type); | ||
| ... | ||
| } | ||
|
|
||
| Index<Vertex> index = GraphDB.getIndex(A.class.getSimpleName(), Vertex.class); | ||
| Iterable<Vertex> types = index.get("type", "text"); | ||
|
|
||
| ### For Controllers | ||
| ####[@WithGraphDB](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/annotations/WithGraphDB.java) | ||
| The **@WithGraphDB** annotation enables annotated Actions and/or Controllers to use **OrientDB** implicitly. | ||
|
|
||
| Known Issues | ||
| ============= | ||
| * Nothing | ||
|
|
||
| Licence | ||
| ======== | ||
| Frames-OrientDB Plugin is distributed under the [Apache 2 licence](http://www.apache.org/licenses/LICENSE-2.0.html). | ||
| What is Frames-OrientDB Plugin ? | ||
| ============ | ||
|
|
||
| **Frames-OrientDB plugin** is a Java O/G mapper for the [OrientDB](http://www.orientdb.org/) with the [Play! framework](http://www.playframework.org/) 2. It is used with the [TinkerPop Frames](https://github.com/tinkerpop/frames/wiki) for O/G mapping. | ||
|
|
||
| Features | ||
| ====== | ||
|
|
||
| * Object-Graph-Mapping by the [TinkerPop Frames](https://github.com/tinkerpop/frames/wiki) | ||
|
|
||
| * Support for both the embedded OrientDB and remote OrientDB | ||
|
|
||
| * Auto-reloading support | ||
|
|
||
| * Custom vertex and edge types support [(sample)](samples/frames-simple-app-with-custom-types) | ||
| * Note that Custom types, Constraints and Indexes are not yet implemented. | ||
|
|
||
| * Support to enable to customize the format of Model Id ([src](app/com/wingnest/play2/frames/plugin/orientdb/CustomIdManager.java)) | ||
|
|
||
| * On only embedded OrienDB: | ||
|
|
||
| * Support to enable to use the [OrientDB Studio](https://github.com/nuvolabase/orientdb/wiki/OrientDB-Studio) | ||
|
|
||
| Requirements | ||
| ========= | ||
|
|
||
| * Java 5 or 6, 7 | ||
| * Play 2.2.1 | ||
|
|
||
| Dependencies | ||
| ============ | ||
|
|
||
| * OrientDB 1.5.1 | ||
|
|
||
| Install | ||
| ==== | ||
|
|
||
| 1) Install Play framework 2.2 | ||
|
|
||
| 2) Executing the command for installing the [TinkerPop Frames Module](http://goo.gl/0g43T) | ||
|
|
||
| % git clone git@github.com:sgougi/play21-frames-module.git | ||
| % cd play21-frames-module | ||
| % git checkout 2.4.3 | ||
|
|
||
| 3) Publishing the Frames Module to your local repository | ||
|
|
||
| % cd play21-frames-module | ||
| % play publish-local | ||
|
|
||
| 4) Executing the command for installing the Frames-OrientDB Plugin | ||
|
|
||
| % git clone git@github.com:sgougi/play21-frames-orientdb-plugin.git | ||
| 5) Publishing the Frames-OrientDB Plugin to your local repository | ||
|
|
||
| % cd play21-frames-orientdb-plugin | ||
| % play publish-local | ||
|
|
||
|
|
||
| Run sample application | ||
| ======================= | ||
|
|
||
| At a command prompt, type the following commands: | ||
|
|
||
| % cd play21-frames-orientdb-plugin | ||
| % cd samples | ||
| % cd frames-simple-app | ||
| % play run | ||
|
|
||
| There are basic usage in the source code of a [sample application](samples). | ||
|
|
||
| * [Annotated model classes](samples/frames-simple-app/app/models) | ||
| * [Creating a key index](samples/frames-simple-app/app/Global.java) | ||
| * [Application configuration: conf/application.conf](samples/frames-simple-app/conf/application.conf) | ||
| * [Dependency settings: project/Build.scala](samples/frames-simple-app/project/Build.scala) | ||
| * [Controller with transaction](samples/frames-simple-app/app/controllers/Application.java) | ||
|
|
||
| ## Facade Classes for GraphDB | ||
|
|
||
| The com.wingnest.play2.frames.[GraphDB](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/GraphDB.java) class is a Facade class. | ||
|
|
||
| * GraphDB.commit() | ||
| * GraphDB.rollback() | ||
| * GraphDB.getGraph() | ||
| * GraphDB.createFramedGraph() | ||
| * GraphDB.getGraphManager() | ||
| * GraphDB.createKeyIndex() | ||
| * GraphDB.dropKeyIndex() | ||
| * GraphDB.createIndex() | ||
| * GraphDB.dropIndex() | ||
| * GraphDB.getIndexedKeys() | ||
| * GraphDB.getIndex() | ||
| * GraphDB.getIndices() | ||
|
|
||
| The com.wingnest.play2.frames.[OrientDB] (app/com/wingnest/play2/frames/OrientDB.java) class is a Facade class. | ||
|
|
||
| * OrientDB.fromCustomIdToORID() | ||
| * OrientDB.fromORIDToCustomId() | ||
| * OrientDB.setCustomIdHandler() | ||
|
|
||
| ## Extended Annotations | ||
|
|
||
| ### For Models | ||
| ####[@Id](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/annotations/Id.java) | ||
| Defines one attribute as id attribute. | ||
|
|
||
| ex: | ||
|
|
||
| public interface A { | ||
| ... | ||
| @Id | ||
| public Object getId(); | ||
| ... | ||
| } | ||
| ####[@CustomId](app/com/wingnest/play2/frames/annotations/CustomId.java) | ||
| Defines one attribute as custom id attribute. (ref:([CustomIdManager](app/com/wingnest/play2/frames/plugin/orientdb/CustomIdManager.java))) | ||
|
|
||
| ex: | ||
|
|
||
| public interface A { | ||
| ... | ||
| @CustomId | ||
| public Object getCustomId(); | ||
| ... | ||
| } | ||
|
|
||
| ####[@IndexedProperty](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/annotations/IndexedProperty.java) | ||
| Defines one or more attributes as indexed attribute. | ||
|
|
||
| ex: | ||
|
|
||
| public interface A { | ||
| ... | ||
| @IndexedProperty("type") | ||
| public String getType(); | ||
| @IndexedProperty("type") | ||
| public void setType(String type); | ||
| ... | ||
| } | ||
|
|
||
| Index<Vertex> index = GraphDB.getIndex(A.class.getSimpleName(), Vertex.class); | ||
| Iterable<Vertex> types = index.get("type", "text"); | ||
|
|
||
| ### For Controllers | ||
| ####[@WithGraphDB](https://github.com/sgougi/play21-frames-module/blob/master/app/com/wingnest/play2/frames/annotations/WithGraphDB.java) | ||
| The **@WithGraphDB** annotation enables annotated Actions and/or Controllers to use **OrientDB** implicitly. | ||
|
|
||
| Known Issues | ||
| ============= | ||
| * Nothing | ||
|
|
||
| Licence | ||
| ======== | ||
| Frames-OrientDB Plugin is distributed under the [Apache 2 licence](http://www.apache.org/licenses/LICENSE-2.0.html). |
52 changes: 26 additions & 26 deletions
52
app/com/wingnest/play2/frames/annotations/CustomEdge.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,26 @@ | ||
| /* | ||
| * Copyright since 2013 Shigeru GOUGI (sgougi@gmail.com) | ||
| * | ||
| * Licensed 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 com.wingnest.play2.frames.annotations; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| @Target(ElementType.TYPE) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| public @interface CustomEdge { | ||
| } | ||
| /* | ||
| * Copyright since 2013 Shigeru GOUGI (sgougi@gmail.com) | ||
| * | ||
| * Licensed 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 com.wingnest.play2.frames.annotations; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| @Target(ElementType.TYPE) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| public @interface CustomEdge { | ||
| } |
Oops, something went wrong.