Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Scrollbar

icons	false

...

Page info

...

title
title

Panel

title	Contents of this Page

Table of Contents

minLevel	2

Overview

The spring framework has emerged over the last few years as a versatile and efficient support structure for multiple types of Java applications. The MVC component facilitates the development of rich web-driven applications. The SpringSource tool suite(STS) is an Eclipse derivative software package bundling the necessary tools to develop efficiently with the Spring framework. The Spring 3 MVC project is a Maven compliant project and the guide will make use of it to include a LexEVS dependency.

This guide will illustrate how to use a local instance of LexEVS in a Spring 3.0.x MVC project and how to deploy it to a Tomcat 6 server from within STS. It was tested using LexEVS 6.0 and Windows 7. This should be applicable to other environments and future versions of LexEVS, but some parameters, especially paths, might need to be formatted differently.

This guide will NOT explore how to leverage LexEVS programatically or how to best develop with the Spring framework. The reader is invited to explore the multiple resources on the web that can help in this endeavor.

Prerequisites

You will need internet access to complete this guide.

LexEVS Local Runtime Install

Please follow carefully the steps mentioned in the Installing LexEVS 6.0 Local Runtime guide.

Once all the steps have been followed successfully you should have a functional LexEVS Local Runtime instance.

In order to facilitate subsequent testing, please load and activate the test terminology Automobiles.xml located in the folder {LEXEVS_HOME}\test\resources\testData\Automobiles.xml

...

Make

...

note

...

your

...

installation

...

folder.

...

Installing

...

Tomcat

...

6

...

Navigate
...
to
...
the
...
Tomcat
...
6
...
download
...
page
...
and
...
download
...
the
...
appropriate
...
package
...
for
...
your
...
system.
...
The
...
binary
...
core
...
distribution
...
(zip)
...
is
...
the
...
most
...
usual
...
one.
...
Unzip
...
the
...
content
...
of
...
the
...
file
...
in
...
the
...
desired
...
folder
...
and
...
make
...
note
...
of
...
it.
...

Installing

...

SpringSource

...

Tool

...

Suite

...

(Tested

...

with

...

Version

...

2.7.1)

...

Navigate
...
to
...
the
...
STS
...
download
...
page
...
to
...
download
...
the
...
software.
...
Please
...
note
...
that
...
you
...
don't
...
have
...
to
...
fill
...
out
...
the
...
form.
...
If
...
you
...
do
...
not
...
wish
...
to
...
fill
...
it
...
all,
...
just
...
check
...
the
...
checkbox
...
to
...
accept
...
the
...
license
...
terms
...
and
...
click
...
on
...
the
...
link
...
"Download
...
Page"
...
bellow
...
the
...
"Download
...
Now"
...
button.
...
Choose
...
the
...
appropriate
...
version
...
for
...
your
...
environment
...
and
...
install
...
it.
...
Make
...
sure
...
that
...
you
...
have
...
the
...
Java
...
JDK
...
1.6
...
(or
...
less
...
ideally
...
1.5)
...
installed.
...
During
...
setup,
...
make
...
sure
...
to
...
make
...
a
...
note
...
of
...
where
...
you
...
installed
...
the
...
program.
...
During
...
step
...
4,
...
make
...
sure
...
"Apache
...
Maven
...
2..."
...
in
...
selected.
...
You
...
can
...
launch
...
STS
...
and
...
select
...
the
...
location
...
of
...
your
...
workspace.
...
You
...
will
...
then
...
be
...
presented
...
with
...
the
...
Welcome
...
page.
...
You
...
can
...
close
...
it
...
with
...
the
...
"x"
...
next
...
to
...
the
...
tab
...
on
...
top
...
left.
...
This
...
will
...
bring
...
a
...
Spring
...
perspective.
...

Setting

...

up

...

Tomcat

...

6

...

in

...

STS

...

Open
...
STS.
...
It
...
should
...
be
...
enabled
...
by
...
default
...
but
...
make
...
sure
...
you're
...
in
...
the
...
Spring
...
perspective.
...
In
...
the
...
left
...
lower
...
corner
...
should
...
be
...
the
...
server
...
view.
...
Right-click
...
in
...
the
...
view
...
and
...
choose
...
"New
...
->
...
Server"
...
in
...
the
...
context
...
menu.
...
Type
...
"Tomcat"
...
in
...
the
...
"Select
...
the
...
server
...
type:"
...
textbox.
...
Then
...
scroll
...
down
...
in
...
the
...
selectbox
...
bellow
...
and
...
choose
...
Tomcat
...
v6.0
...
Server.
...
Click
...
"Next".
...
On
...
the
...
next
...
screen,
...
browse
...
to
...
your
...
tomcat
...
install
...
folder
...
and
...
select
...
it.
...
Click
...
on
...
"Finish"
...

You
...
should
...
now
...
see
...
an
...
entry
...
named
...
"Tomcat
...
v6.0
...
Server
...
at
...
localhost"
...
in
...
the
...
server view.

Creating a New Spring MVC 3 Project

Click on the menu File -> New - > Spring Template Project.
Select Spring MVC Project from the list and click Next.
1. It will ask you if you want to download file: click Proceed.
Enter a project name. For this guide we will name it "testlex".
Enter the top level package (x.x.x).

...

will

...

name

...

"org.test.test".

...

Wiki Markup
Click on Finish. It might take some time before your back to a responsive Spring perspective. STS will need to download some dependencies for the project. You should then see your project \[

...

testlex\] in the package explorer view on top left part of the windows.

...

Small

...

STS

...

Warning

...

That

...

Can

...

be

...

Fixed

...

There

...

little

...

bug

...

that

...

annoying

...

STS

...

regarding

...

missing

...

XML

...

definition.

...

You

...

should

...

see

...

tiny

...

warning

...

icon

...

your

...

project

...

and

...

you

...

drill

...

down,

...

relates

...

the

...

file

...

"log4j.xml".

...

The

...

issue

...

has

...

been

...

described

...

Spring

...

forum

...

post

...

but

...

the

...

"Key"

...

that

...

needs

...

entered

...

is:

{

No Format
}-//APACHE//DTD LOG4J 1.2//EN{noformat} *

and

...

NOT

...

-//LOGGER

...

this

...

changed

...

from

...

the

...

STS

...

version.

...

The

...

solution

...

is:

...

Windows

...

Preferences

...

Catalog

...

Click

...

Click

...

File

...

System

...

select

...

jar.

...

should

...

something

...

similar

...

{SpringSource

...

install

...

folder

...

}\sts-2.7.1.RELEASE\plugins\org.apache.log4j_1.2.15.v201012070815.jar

...

"jar:file:"

...

front

...

path

...

!/org/apache/log4j/xml/log4j.dtd

...

path

...

(without

...

textbox,

...

enter

...

-//APACHE//DTD

...

LOG4J

...

1.2//EN

...

(without

...

Click

...

this

...

window,

...

then

...

again

...

preference

...

window.

...

Once

...

instructions,

...

need

...

remove

...

space

...

trigger

...

modification

...

then

...

save

...

file.

...

warning

...

should

...

gone.

...

this

...

both

...

log4j.xml

...

files:

...

- one

...

- in

...

- src/main/resources

...

- one in src/test/resources

...

Verification

Wiki Markup
Select the \[

Wiki Markup
Select the \[

...

textlex\] folder project in the package explorer window then click on play button or click on the menu "Run" \-> Run
The next window will ask you how you want to run the project. Select "Run on server".

...

list

...

window,

...

should

...

"Tomcat

...

v6.0

...

Server

...

localhost"

...

entry

...

that

...

created

...

earlier.

...

Select

...

check

...

"Always

...

this

...

server..."

...

Click

...

Next

...

then

...

click

...

Finish

...

should

...

then

...

"Hello

...

world

...

page

...

with

...

current

...

time

...

have

...

functioning

...

Spring

...

3 MVC project.

Adding LexEVS as a Maven Dependency

The Spring 3 MVC project being a Maven compliant project, we will add LexEVS as dependency. It is not available in a public repository so we will need to install in our local repository first.

Downloading the Required Files

You will need four files to successfully add LexEVS as a dependency.

LexEVS jar: Can be found in your local LexEVS install: {LEXEVS_HOME}\runtime-components\lexbig.jar

...

- For easier access,

...

- copy

...

- it

...

- to

...

- short

...

- location.

...

- We

...

- will

...

- use

...

- E:\

...

LexEVS

...

file:

...

This

...

includes

...

information

...

dependencies

...

LexEVS

...

will

...

rely

...

download

...

Lexevs-6.0.0.pom.zip

...

- Wiki Markup
  Unzip it to the same location \[E:\]

Wiki Markup
Unzip it to the same location \[E:\]

...

LexEVS

...

uses

...

patched

...

version

...

dependency

...

ddlutils.

...

need

...

download

...

here
- Wiki Markup
  Place it in the same directory \[E:\]

Wiki Markup
Place it in the same directory \[E:\]

...

This

...

dependency

...

also

...

file

...

which

...

download

...

Ddlutils-1.0-PATCHED.pom.zip

...

- Wiki Markup
  Unzip it to the same location \[E:\]

Wiki Markup
Unzip it to the same location \[E:\]

...

Installing

...

a

...

LexEVS

...

Dependency

...

As
...
these
...
Maven
...
dependencies
...
are
...
not
...
available
...
in
...
a
...
public
...
repository,
...
you
...
will
...
need
...
to
...
add
...
them
...
to
...
our
...
local
...
repository.
...
Open
...
a
...
command
...
window
...
and
...
navigate
...
to
...
the
...
{SpringSource
...
install
...
folder
...
}\maven-2.2.1.RELEASE\bin
...
folder.
...
On
...
Windows
...
7,
...
you
...
can
...
use
...
the
...
file
...
explorer
...
to
...
navigate
...
to
...
this
...
folder
...
and
...
then
...
"Shift+right
...
click"
...
in
...
the
...
folder
...
and
...
select
...
"Open
...
command
...
window
...
here".
...

JAVA_HOME

...

Environment

...

Variable

...

Missing

...

Should
...
you
...
have
...
an
...
error
...
message
...
stating
...
the
...
need
...
for
...
a
...
JAVA_HOME
...
system
...
variable
...
when
...
you
...
execute
...
the
...
MVN
...
commands,
...
please
...
follow
...
the
...
appropriate
...
steps
...
for
...
your
...
system
...
to
...
add
...
it
...
(steps
...
provided
...
bellow
...
for
...
Windows
...
7).
...
On
...
Windows
...
7,
...
click
...
on
...
the
...
start
...
button,
...
then
...
right-click
...
on
...
computer
...
and
...
select
...
properties.
...
Select
...
Advanced
...
system
...
settings
...
in
...
the
...
left
...
pane
...
and
...
select
...
the
...
advanced
...
tab
...
in
...
the
...
window
...
that
...
opens
...
up.
...
Click
...
on
...
Environment
...
Variables
...
button.
...
Click
...
on
...
the
...
button
...
New
...
in
...
the
...
lower
...
half
...
of
...
the
...
window
...
and
...
add
...
JAVA_HOME
...
as
...
a
...
name
...
and
...
the
...
path
...
to
...
your
...
JRE
...
installation
...
as
...
a
...
value.
...
Click
...
OK
...
3
...
times
...
to
...
close
...
the
...
windows.
...
Close
...
and
...
reopen
...
your
...
commmand
...
window
...
and
...
it
...
should
...
now
...
work.
...

MVN

...

Commands

...

For

...

all

...

the

...

following

...

commands,

...

please

...

change

...

*E:

...

the

...

path

...

the

...

folder

...

chosen

...

place

...

the

...

four

...

files

...

above.

...

Then

...

enter

...

this

...

command

...

command

...

prompt:

...

Code Block

...


mvn install:install-file -Dfile="E:\ddlUtils-1.0-PATCHED.jar" -DpomFile="E:\ddlutils-1.0-PATCHED.pom"

...

should

...

then

...

build

...

successful

...

message.

...

ddlUtils

...

dependency

...

available

...

your

...

local

...

repository.

...

enter

...

this

...

command

...

command

...

prompt:

...

Code Block

...


mvn install:install-file -Dfile="E:\lexbig.jar" -DpomFile="E:\lexevs-6.0.0.pom"

...

should

...

also

...

build

...

successful

...

message.

...

LexEVS

...

dependency

...

available

...

your

...

local

...

repository.

...

Open

...

select

...

Window

...

Show

...

View

...

Other

...

Scroll

...

down

...

folder

...

Maven

...

select

...

Maven

...

Repositories.

...

Click

...

should

...

have

...

Maven

...

Repositories

...

view

...

lower

...

part

...

window.

...

Select

...

unfold

...

Local

...

Repositories.

...

Right-click

...

Local

...

Repository

...

select

...

Rebuild

...

Index

...

from

...

context

...

menu.

...

Click

...

when

...

asked

...

you're

...

sure

...

want

...

rebuild

...

Adjusting

...

Scope

...

of

...

JUnit

...

LexEVS

...

currently

...

uses

...

JUnit

...

during

...

runtime.

...

This

...

bit

...

unusual

...

and

...

might

...

change

...

future

...

release

...

but

...

for

...

now,

...

needs

...

adjusted.

...

Wiki Markup
Select the project folder \[

Wiki Markup
Select the project folder \[

...

testlex\] in the Package Explorer view and unfold it.

...

Double

...

click

...

pom.xml

...

file

...

open

...

Select

...

Dependencies

...

bottom

...

window.

...

Dependencies

...

pane,

...

scroll

...

down

...

dependencies

...

selectbox

...

click

...

once

...

junit.

...

right

...

side,

...

Dependency

...

Details

...

area

...

should

...

present

...

scope

...

which

...

"test"

...

combobox.

...

Change

...

compile.

...

Click

...

File

...

Save

...

press

...

Ctrl-s.

...

Including LexEVS in the MVC Project

Wiki Markup
Select the \[

Wiki Markup
Select the \[

...

textlex\] project. Right-click on it and select Maven \-> Add Dependency from the context menu.

...

Enter

...

lexevs

...

first

...

textbox.

...

results

...

should

...

show:

...

lexevs

...

lexevs

...

Select

...

click

...

will

...

download

...

dependencies

...

needed

...

work

...

with

...

LexEVS.

...

progress

...

progress

...

view

...

(tab).

...

Creating

...

a

...

Test

...

File

Wiki Markup
Select and unfold the project folder \[

Wiki Markup
Select and unfold the project folder \[

...

textlex\] in the package explorer.

...

Wiki Markup
Navigate to src/test/java. You should see an empty package \[

...

org.test.test\]

...

Right-click

...

select

...

JUnit

...

Test

...

Case

...

name

...

your

...

test

...

name

...

textbox.

...

will

...

name

...

LexBigConnect.

...

Click

...

Finish.

...

Copy

...

this

...

file

...

(including

...

last

...

bracket):

...

Code Block

...


package org.test.test; import static org.junit.Assert.*; import org.LexGrid.LexBIG.Exceptions.LBInvocationException; import org.LexGrid.LexBIG.Impl.LexBIGServiceImpl; import org.LexGrid.LexBIG.LexBIGService.LexBIGService; import org.LexGrid.LexBIG.DataModel.InterfaceElements.CodingSchemeRendering; import org.junit.Test; public class LexBigConnect { @Test public void test() throws LBInvocationException { LexBIGService lbSvc = LexBIGServiceImpl.defaultInstance(); System.out.println("The currently active terminologies are:"); for(CodingSchemeRendering csr : lbSvc.getSupportedCodingSchemes().getCodingSchemeRendering()) System.out.println(csr.getCodingSchemeSummary().getFormalName()); assertTrue(true); } }

package org.test.test;

import static org.junit.Assert.*;

import org.LexGrid.LexBIG.Exceptions.LBInvocationException;
import org.LexGrid.LexBIG.Impl.LexBIGServiceImpl;
import org.LexGrid.LexBIG.LexBIGService.LexBIGService;
import org.LexGrid.LexBIG.DataModel.InterfaceElements.CodingSchemeRendering;

import org.junit.Test;

public class LexBigConnect {

    @Test
    public void test() throws LBInvocationException {

        LexBIGService lbSvc = LexBIGServiceImpl.defaultInstance();
        System.out.println("The currently active terminologies are:");
        for(CodingSchemeRendering csr : lbSvc.getSupportedCodingSchemes().getCodingSchemeRendering())
            System.out.println(csr.getCodingSchemeSummary().getFormalName());

        assertTrue(true);
    }
}

...

Make sure to change the package name if you didn't

...

org.test.test

...

initially.

...

Save

...

file.

...

Adding

...

a

...

JVM

...

Parameter

...

to

...

Locate

...

the

...

lbconfig.props

...

STS,

...

select

...

Configurations...

...

Select

...

JUnit

...

left

...

list.

...

Wiki Markup
Select the new button (white rectangle with a little yellow \+) The name of the profile will be defaulted to the name of your class \[

...

LexBigConnect\]

...

Click

...

Arguments

...

this

...

parameter

...

textbox:

...

Code Block

...


-DLG_CONFIG_FILE="\{LEXEVS_HOME\}\resources\config\lbconfig.props"

...

Replace {LEXEVS_HOME

...

}

...

absolute

...

path

...

LexEVS

...

local

...

install

...

done

...

earlier

...

process.

...

Wiki Markup

Then click Apply followed by Run.
You should then see a successful completion of a JUnit test. The console log will also show "The currently active terminologies are:" followed by the name of the terminologies \[

...

Automobiles\] if you loaded it

...

Integrating LexEVS in a Web Page

Adding a JVM Parameter to Locate the lbconfig.props

I# n STS, double-click on the "Tomcat v6.0..."

...

entry

...

the

...

server

...

view

...

(left

...

lower

...

corner).

...

This

...

will

...

open

...

server

...

Overview.

...

Click

...

"Open

...

launch

...

configuration"

...

link

...

General

...

Information

...

section.

...

Select

...

Arguments

...

arguments

...

textbox,

...

bottom,

...

after

...

existing

...

arguments

...

this:

...

Code Block

...


-DLG_CONFIG_FILE="\{LEXEVS_HOME\}\resources\config\lbconfig.props"

...

Replace {LEXEVS_HOME

...

}

...

absolute

...

path

...

LexEVS

...

local

...

install

...

done

...

earlier

...

process.

...

Make

...

sure

...

there's

...

space

...

between

...

last

...

existing

...

argument

...

dash

...

this

...

one.

...

Click

...

Apply

...

then

...

click

...

Adjusting

...

the

...

Controller

...

Although

...

this

...

unlikely

...

the

...

way

...

which

...

you

...

will

...

integrate

...

LexEVS

...

MVC

...

project,

...

will

...

confirm

...

that

...

using

...

the

...

project

...

with

...

Tomcat

...

works.

...

This

...

assumes

...

that

...

you

...

have

...

least

...

one

...

loaded

...

and

...

active

...

terminology

...

your

...

local

...

LexEVS

...

Server.

...

Navigate

...

project

...

tree

...

src/main/java

...

double-click

...

HomeController.java

...

open

...

Copy

...

this

...

file

...

(including

...

last

...

bracket):

...

Code Block

...

package org.test.test;

import java.text.DateFormat;
import java.util.Date;
import java.util.Locale;

import org.LexGrid.LexBIG.DataModel.InterfaceElements.CodingSchemeRendering;
import org.LexGrid.LexBIG.Exceptions.LBInvocationException;
import org.LexGrid.LexBIG.Impl.LexBIGServiceImpl;
import org.LexGrid.LexBIG.LexBIGService.LexBIGService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;


/**
 * Handles requests for the application home page.
 */
@Controller
public class HomeController {

    private static final Logger logger = LoggerFactory.getLogger(HomeController.class);

    /**
     * Simply selects the home view to render by returning its name.
     * @throws LBInvocationException
     */
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String home(Locale locale, Model model) throws LBInvocationException {
        logger.info("Welcome home! the client locale is "+ locale.toString());

        Date date = new Date();
        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale);

        String formattedDate = dateFormat.format(date);

        model.addAttribute("serverTime", formattedDate );

        Integer n = 1;

        LexBIGService lbSvc = LexBIGServiceImpl.defaultInstance();
        for(CodingSchemeRendering csr : lbSvc.getSupportedCodingSchemes().getCodingSchemeRendering()){
            System.out.println(csr.getCodingSchemeSummary().getFormalName());
            model.addAttribute("term"+n.toString(), csr.getCodingSchemeSummary().getFormalName());
            n++;
        }

        return "home";
    }

}

...

Make sure to change the package name if you didn't

...

org.test.test

...

initially.

...

Save

...

file.

...

Adjusting

...

the

...

JSP

...

Page

...

Package

...

Explorer,

...

nagivate

...

src/main/webapp/WEB-INF/views

...

open

...

home.jsp

...

double-clicking.

...

Replace

...

text

...

file

...

with

...

this

...

one:

...

Code Block

...

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ page session="false" %>
<html>
<head>
    <title>Home</title>
</head>
<body>
<h1>
    Hello world!
</h1>

<p>The time on the server is ${serverTime}.</p>
<p>One of the active terminologies on the LexEVS server is: ${term1}</p>
</body>
</html>

...

Save the file and close it.

Running the Project

Wiki Markup
Select the project \[

...

textlex\] in the Package Explorer.

...

Select

...

Run.

...

Select

...

"Run

...

Server"

...

then

...

click

...

should

...

home

...

page

...

displayed

...

with

...

date/time

...

and,

...

last

...

line,

...

name

...

your

...

active

...

terminology

...

LexEVS.

...

have

...

functional

...

Spring

...

project

...

interacting

...

successfully

...

with

...

local

...

instance

...

LexEVS.

...

Acknowledgement

This guide was contributed by the TRANSFoRM group / INSERM U936.

Scrollbar

icons	false

Content

Space Tools

Page History

Versions Compared

Old Version 13

New Version 14

Key

Page info

titletitle

Overview

Prerequisites

LexEVS Local Runtime Install

Installing

Tomcat

6

Installing

SpringSource

Tool

Suite

(Tested

with

Version

2.7.1)

Setting

up

Tomcat

6

in

STS

Creating a New Spring MVC 3 Project

Small

STS

Warning

That

Can

be

Fixed

Verification

Adding LexEVS as a Maven Dependency

Downloading the Required Files

Installing

a

LexEVS

Dependency

JAVA_HOME

Environment

Variable

Missing

MVN

Commands

Adjusting

Scope

of

JUnit

Including LexEVS in the MVC Project

Creating

a

Test

File

Adding

a

JVM

Parameter

to

Locate

the

lbconfig.props

Integrating LexEVS in a Web Page

Adding a JVM Parameter to Locate the lbconfig.props

Adjusting

the

Controller

Adjusting

the

JSP

Page

Running the Project

Acknowledgement

title
title