Login required
Download

Taggable Plugin

 (5)
Author(s): graemerocher
Current Release: 0.6.1
Grails Version: 1.1 > *
Tags community functionality tagging
Fisheye
Docs
Edit Plugin

Taggable Plugin

This plugin provides an alternative to the Acts as Taggable hosted at grails.org and with the following features.

  • Classes can be made taggable by implementing the org.grails.taggable.Taggable interface
  • Method chaining can be used to add tags
  • The table name the domain classes use is customizable
  • Utilizes extensive caching to improve performance
  • Property use of packages to avoid domain conflicts

Requirements

Grails Version: 1.1 and above JDK: 1.5 and above

Installation

grails install-plugin taggable

By default the plugin will force all tags to lower case. If you want to preserve the case of tags, you must specify the following in Config.groovy:

grails.taggable.preserve.case = true

This will preserve the supplied case of tags when adding and removing them. Eg adding tags "grails" and "Grails" will result in two tags on the object. The finder methods for locating objects by tag still require the exact case of the tag you want to find - each tag is treated as discrete.

Usage

Implement the Taggable interface:

import org.grails.taggable.*
class Vehicle implements Taggable {
}

Add some tags:

def v = Vehicle.get(1)
v.addTag("red")
 .addTag("sporty")
 .addTag("expensive")
// Alternatively
v.setTags(['red', 'sporty', 'expensive'])
// Or
v.addTags(['electric', 'hybrid'])

Query:

def v = Vehicle.get(1)
println v.tags
def vehicles = Vehicle.findAllByTag("sporty") // Also takes params eg [max:5]
def count = Vehicle.countByTag("sporty")
assert 3 == Vehicle.totalTags
assert ['expensive', 'red','sporty'] == Vehicle.allTags
// Find all cars with tag "electric", where the instances also 
def teslaElectricCars = Vehicle.findAllByTagWithCriteria('electric') {
    eq('manufacturer', 'Tesla Motors')
}
// Find all the tags for this class, using the supplied params and criteria that operate on the TAGS
def fiveCoolTags = Vehicle.findAllTagsWithCriteria( [max:5]) {
    ilike('name', '%cool%')
}

Tag parsing:

def tags = "red,sporty,expensive"
def v = Vehicle.get(1)
v.parseTags(tags)
assert ['expensive', 'red','sporty'] == v.tags
tags = "red/sporty/expensive"
v.parseTags(tags, "/")
assert ['expensive', 'red','sporty'] == v.tags

Customized Table names in Config.groovy:

grails.taggable.tag.table="MY_TAGS"
grails.taggable.tagLink.table="MY_TAG_LINKS"