Code Monkey home page Code Monkey logo

yuma4j's Introduction

yuma4j

yuma4j will be a collection of Java utilities complementing the yuma.js media annotation system, including a basic annotation storage server.

Getting Started with the Demo Annotation Server

yuma4j includes a bare-bones annotation storage server you can use to make annotations on your site permanent. The demo server also provides a basic search GUI and a 'public timeline' which shows the 20 most recent annotations in the system.

To point [yuma.min.js] (http://github.com/rsimon/yuma.min.js) to an annotation server, you need to set the serverURL init parameter. The code sample below shows how this is done in case of image annotation.

 <head>
   ...
   <script type="text/javascript">
   var annotationLayer;
   
   window.onYUMAready = function() {
     annotationLayer = new YUMA.ImageAnnotationLayer('annotateMe', { serverURL:"http://my.server.org/myserver" });
   }
   </script>
 </head>

Note that we have also set up a publicly accessible demo server instance at

http://dme.ait.ac.at/yuma4j-server

Feel free to point your page to this server for testing purposes. Keep in mind though that we do not make any guarantees on this server in terms of

  • server uptime
  • availability of your annotations - we may occasionally clear the database as we are developing yuma4j further

Furthermore, be aware that the server is open to everyone. This means anybody can search through your annotations and see them in the public timeline. Private annotations and non-anonymous posting are not (yet) supported by the demo server!

Developer Info

yuma4j requires [Java 1.6] (http://www.java.com/de/download/index.jsp) and is built with [Gradle] (http://www.gradle.org/).

For those using Eclipse:

gradle eclipse

will generate Eclipse project files.

gradle jettyRun

will launch a local demo annotation storage server. The demo server runs with an embedded in-memory database. There is no need to set up any additional components on your system. After launch, it will be available at

http://localhost:8081/yuma4j-server

yuma4j uses the [Hibernate] (http://www.hibernate.org/) database persistence framework. You can switch out the demo server's in-memory database with a [database of your choice] (http://community.jboss.org/wiki/SupportedDatabases2) by editing the persistence.xml file located in the [src/main/resources/META-INF/] (https://github.com/rsimon/yuma4j/tree/master/src/main/resources/META-INF) folder.

To deploy the demo server in you own environment, you will need a Java Servlet container that implements the Servlet 2.4 specification, for example Tomcat 5.5 (or higher) or Jetty 6 (or higher). Use

gradle war

To build the deployable Web archive (.war) file.

yuma4j's People

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.