Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A module for Apache Isis that allow tags (or labels) to be associated with other entities.
Java HTML Shell CSS
branch: master

README.md

isis-module-tags

Build Status

This module, intended for use within Apache Isis, provides the ability to add multiple tags (or labels) to any entity.

For example, an Email entity could be associated with a priority tag of 'urgent', 'normal' or 'low', and could also have a category tag of 'work', 'family', 'friends'.

The idea is to allow a user to label an entity by offering a choice of other existing tags associated with other entities of the same type and also tag type. That is, the combination of the entity type (eg com.mycompany.myapp.Email) and the tag type (eg priority) creates a named set of available tags (eg 'urgent', 'normal', low').

As well as listing existing tags, new tags can of course also be created, and existing tags updated or removed.

Screenshots

The following screenshots show an example app's usage of the module with some sample fixture data:

Install example fixtures

... returning an example entity "Bip". The class of this entity is not of interest, what is of interest is that it has two properties, brand and sector, that correspond to Tags:

Update tag

Using the action, can update tag. The Tags service provides a list of available tag (names) for this entity type and tag name ("brand"):

The tag can then be saved:

If the tag is updated once more, note that the original tag ("Coca Cola") is no longer listed. This is because there are no other entities that have this label:

New tags

New tags can also be created. Enter the tag name:

The tag is saved:

... and is available as a choice for this or any other entity of the same type:

How to run the Demo App

The prerequisite software is:

  • Java JDK 7 (nb: Isis currently does not support JDK 8)
  • maven 3 (3.2.x is recommended).

To build the demo app:

git clone https://github.com/isisaddons/isis-module-tags.git
mvn clean install

To run the demo app:

mvn antrun:run -P self-host

Then log on using user: sven, password: pass

How to configure/use

You can either use this module "out-of-the-box", or you can fork this repo and extend to your own requirements.

"Out-of-the-box"

To use "out-of-the-box":

  • update your classpath by adding this dependency in your dom project's pom.xml:
    <dependency>
        <groupId>org.isisaddons.module.tags</groupId>
        <artifactId>isis-module-tags-dom</artifactId>
        <version>1.8.0</version>
    </dependency>
  • update your WEB-INF/isis.properties:
    isis.services-installer=configuration-and-annotation
    isis.services.ServicesInstallerFromAnnotation.packagePrefix=
                    ...,\
                    org.isisaddons.module.tags.dom,\
                    ...

Check for later releases by searching Maven Central Repo.

"Out-of-the-box" (-SNAPSHOT)

If you want to use the current -SNAPSHOT, then the steps are the same as above, except:

  • when updating the classpath, specify the appropriate -SNAPSHOT version:
    <version>1.9.0-SNAPSHOT</version>
  • add the repository definition to pick up the most recent snapshot (we use the Cloudbees continuous integration service). We suggest defining the repository in a <profile>:
    <profile>
        <id>cloudbees-snapshots</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <repositories>
            <repository>
                <id>snapshots-repo</id>
                <url>http://repository-estatio.forge.cloudbees.com/snapshot/</url>
                <releases>
                    <enabled>false</enabled>
                </releases>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </repository>
        </repositories>
    </profile>

Forking the repo

If instead you want to extend this module's functionality, then we recommend that you fork this repo. The repo is structured as follows:

  • pom.xml // parent pom
  • dom // the module implementation, depends on Isis applib
  • fixture // fixtures, holding a sample domain objects and fixture scripts; depends on dom
  • integtests // integration tests for the module; depends on fixture
  • webapp // demo webapp (see above screenshots); depends on dom and fixture

Only the dom project is released to Maven Central Repo. The versions of the other modules are purposely left at 0.0.1-SNAPSHOT because they are not intended to be released.

API

The main functionality is exposed through the Tags domain service, which provides two methods:

public class Tags {

    @Programmatic
    public List<String> choices(final Object taggedObject, final String tagKey) { ... }

    @Programmatic
    public Tag tagFor(
            final Object taggedObject,
            final Tag existingTag, 
            final String tagKey, final String tagValue) { ... }
}

where:

  • choices(...) returns a list of tags as strings for the object being tagged (eg Email) and for the tag key (eg priority)

  • tagFor(...) will create/update a tag for the object being tagged (eg Email), the tag key (eg priority) and the tag value (eg 'urgent'). The existing tag (if any) is passed in so that it can be removed if the tag value is left as null.

Change Log

  • 1.8.0 - released against Isis 1.8.0
  • 1.7.0 - released against Isis 1.7.0
  • 1.6.0 - first release, with classes under package org.isisaddons.module.tags

Legal Stuff

License

Copyright 2014 Dan Haywood

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.

Dependencies

There are no third-party dependencies.

Maven deploy notes

Only the dom module is deployed, and is done so using Sonatype's OSS support (see user guide).

Release to Sonatype's Snapshot Repo

To deploy a snapshot, use:

pushd dom
mvn clean deploy
popd

The artifacts should be available in Sonatype's Snapshot Repo.

Release to Maven Central

The release.sh script automates the release process. It performs the following:

  • performs a sanity check (mvn clean install -o) that everything builds ok
  • bumps the pom.xml to a specified release version, and tag
  • performs a double check (mvn clean install -o) that everything still builds ok
  • releases the code using mvn clean deploy
  • bumps the pom.xml to a specified release version

For example:

sh release.sh 1.9.0 \
              1.10.0-SNAPSHOT \
              dan@haywood-associates.co.uk \
              "this is not really my passphrase"

where

  • $1 is the release version
  • $2 is the snapshot version
  • $3 is the email of the secret key (~/.gnupg/secring.gpg) to use for signing
  • $4 is the corresponding passphrase for that secret key.

Other ways of specifying the key and passphrase are available, see the pgp-maven-plugin's documentation).

If the script completes successfully, then push changes:

git push origin master
git push origin 1.9.0

If the script fails to complete, then identify the cause, perform a git reset --hard to start over and fix the issue before trying again. Note that in the dom's pom.xml the nexus-staging-maven-plugin has the autoReleaseAfterClose setting set to true (to automatically stage, close and the release the repo). You may want to set this to false if debugging an issue.

According to Sonatype's guide, it takes about 10 minutes to sync, but up to 2 hours to update search.

Something went wrong with that request. Please try again.