Requirement

• System: Ubuntu
• openjdk version "11.0.16" is needed to be installed to Ubuntu
• Docker is needed to be installed to Ubuntu

How to start through Terminal

1. cd to docker directory
2. run . web/start_mariadb.sh and then wait till database is ready
3. run . web/deploy_2_wildfly.sh

Test REST API endpoint:

http://localhost/dictionary/rest/lexicalitems/1

Ubiquitous Language

lexical item

reference: https://en.wikipedia.org/wiki/Lexical_item

Critical question on definition of lexical item :

• could one lexical item have multiple meanings? yes
• does definition belong to lexical item? no. Based on Gemini, the defintion is deparated from lexical item

Based on Gemini, lexical entry has the detail information of lexical item, including the definition, part of speech etc`.

According to Crystal (1980: 274), polysemy is a term used in semantic analysis to refer to a lexical item which has a range of different meanings.

Reference: https://www.iasj.net/iasj/download/5784a6a9435b5c81

lexical entry

reference: https://www.vocabulary.com/dictionary/lexical%20entry

Design Analysis

Critical things to consider

• Key ID generated by the server
• full update is impossible usually since in practice an update is only on one language => PATCH can be used instead of POST for update

New entity Explanation is introduced to aggregate defintion , part of speech , pronunciation etc. along with LexicalItem as foreign key. There is an invariant relationship from lexical item to explanation, i.e. one-to-many. However, when implementing it with JPA/Hibernate, there are at least three ways

Interface design: LexicalItemRepository and ExplanationRepository

Think first from the frontend point of view:

CREATE

• add a full lexical entry including lexical item, defintion, part of speech, example sentences etc.
• ~add a single explanation to an existing lexical entry~

READ

• Given an keyword with value, language and definition language, get all the possible results along with all meanings
• Given a lexical item id get the all the explanations

UPDATE

• Given a lexical item, update it (explanations can be added or removed)
• ~Given an explanation, update it~

DELETE

• Given a lexical item delete it
• ~Given an explanation, delete it~

Unidirectional @ManyToOne Association (Explanation > LexicalItem)

CREATE

• add a full lexical entry including lexical item, defintion, part of speech, example sentences etc. > TODO need separate persist on both LexicalItem and Explanation

READ

• Given an input, get all the possible results along with all meanings: OK
• Given a lexical item id get the all the explanations : OK but the query on ExplanationRepository is not trivial

UPDATE

• Given a lexical item, update it (explanations can be added or removed) : need separate merge on both LexicalItem and Explanation

DELETE

• Given a lexical item delete it : need first LexicalItemRepository.find/EntityManager.find to search for the managed entity and then call EntityManager.remove

This design strategy cannot simply meet the repositories.