ERTaggable (Project Wonder Reference Documentation)

java.lang.Object
- er.taggable.ERTaggable<T>

Type Parameters:

T - the type of EO that is being wrapped
```
public class ERTaggable<T extends ERXGenericRecord>
extends Object
```
ERTaggable provides a wrapper around a taggable EO, extending it with tagging-related methods. Typically you would provide a cover method from your EO to an instance of an ERTaggable:
```
 public class Person extends _Person {
   ...
   public ERTaggable<Person> taggable() {
     return ERTaggable.taggable(this);
   }
 }
 
```
Author:

mschrag

Constructor Summary

Constructors
Modifier Constructor and Description

protected ERTaggable(ERTaggableEntity<T> entity, T item)
Constructs an ERTaggable wrapper.

Constructors
Modifier	Constructor and Description
`protected`	`ERTaggable(ERTaggableEntity<T> entity, T item)` Constructs an ERTaggable wrapper.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addTag(ERTag tag)` Adds the tag to this item.
`void`	`addTagNamed(String tagName)` This method applies tags to the target object, by looking up the corresponding Tag object instances and adding it to the tag collection of the object.
`void`	`addTags(boolean clear, Object tags)` This method applies tags to the target object, by parsing the tags parameter into Tag object instances and adding them to the tag collection of the object.
`void`	`addTags(Object tags)` This method applies tags to the target object, by parsing the tags parameter into Tag object instances and adding them to the tag collection of the object.
`void`	`clearTags()` Removes all of the tags associated with this item.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`boolean`	`isTaggedWith(String tagName)` Checks to see if this object has been tagged with the given tag name.
`boolean`	`isTaggedWithAll(Object tags)` Checks to see if this object has been tagged with all the given tags.
`boolean`	`isTaggedWithAny(Object tags)` Checks to see if this object has been tagged with any of the given tags.
`T`	`item()` Returns the tagged item that this is taggable is wrapping.
`protected void`	`removeTag(ERTag tag)` Removes the tag from this item.
`void`	`removeTagNamed(String tagName)` This method removes tags from the target object, by looking up the corresponding Tag object instances and removing them from the tag collection of the object if they exist.
`void`	`removeTags(Object tags)` This method removes tags from the target object, by parsing the tags parameter into Tag object instances and removing them from the tag collection of the object if they exist.
`void`	`setTags(Object tags)` Clears the current tags collection and sets the tag names for this object.
`static <T extends ERXGenericRecord> ERTaggable<T>`	`taggable(T eo)` A factory method for generating a taggable from an EO.
`ERTaggableEntity<T>`	`taggableEntity()` Returns the taggable entity for this taggable.
`NSArray<String>`	`tagNames()` Returns an array of strings containing the tag names applied to this object.
`NSArray<ERTag>`	`tags()` Returns an array of ERTags associated with this item.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ERTaggable
```
protected ERTaggable(ERTaggableEntity<T> entity,
                     T item)
```
    Constructs an ERTaggable wrapper.
    
    Parameters:
    
    entity - the ERTaggableEntity that corresponds to this item's entity
    
    item - the item to wrap
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - taggable
```
public static <T extends ERXGenericRecord> ERTaggable<T> taggable(T eo)
```
    A factory method for generating a taggable from an EO.
    
    Type Parameters:
    
    T - the type of the EO being wrapped
    
    Parameters:
    
    eo - the EO being wrapped
    
    Returns:
    
    a taggable wrapper around the EO
  - item
```
public T item()
```
    Returns the tagged item that this is taggable is wrapping.
    
    Returns:
    
    the tagged item
  - taggableEntity
```
public ERTaggableEntity<T> taggableEntity()
```
    Returns the taggable entity for this taggable.
    
    Returns:
    
    the taggable entity for this taggable
  - tags
```
public NSArray<ERTag> tags()
```
    Returns an array of ERTags associated with this item.
    
    Returns:
    
    an array of ERTags associated with this item
  - clearTags
```
public void clearTags()
```
    Removes all of the tags associated with this item.
  - removeTags
```
public void removeTags(Object tags)
```
    This method removes tags from the target object, by parsing the tags parameter into Tag object instances and removing them from the tag collection of the object if they exist.
    
    Parameters:
    
    tags - the tags to remove (String to tokenize, NSArray<String>, etc)
  - removeTagNamed
```
public void removeTagNamed(String tagName)
```
    This method removes tags from the target object, by looking up the corresponding Tag object instances and removing them from the tag collection of the object if they exist.
    
    Parameters:
    
    tagName - the tag to remove (String to tokenize, NSArray<String>, etc)
  - addTagNamed
```
public void addTagNamed(String tagName)
```
    This method applies tags to the target object, by looking up the corresponding Tag object instances and adding it to the tag collection of the object. If the tag name already exists in the tags table, it just adds a relationship to the existing tag record. If it doesn't exist, it then creates a new Tag record for it. This is equivalent to addTags(false, tags).
    
    Parameters:
    
    tagName - the tag name to add
  - addTags
```
public void addTags(Object tags)
```
    This method applies tags to the target object, by parsing the tags parameter into Tag object instances and adding them to the tag collection of the object. If the tag name already exists in the tags table, it just adds a relationship to the existing tag record. If it doesn't exist, it then creates a new Tag record for it. This is equivalent to addTags(false, tags).
    
    Parameters:
    
    tags - the tags to add (String to tokenize, NSArray<String>, etc)
  - addTags
```
public void addTags(boolean clear,
                    Object tags)
```
    This method applies tags to the target object, by parsing the tags parameter into Tag object instances and adding them to the tag collection of the object. If the tag name already exists in the tags table, it just adds a relationship to the existing tag record. If it doesn't exist, it then creates a new Tag record for it.
    
    Parameters:
    
    tags - the tags to add (String to tokenize, NSArray<String>, etc)
    
    clear - if true, existing tags will be removed first
  - addTag
```
protected void addTag(ERTag tag)
```
    Adds the tag to this item. This is the single method that to override if you need to perform some additional operations.
    
    Parameters:
    
    tag - the tag to add
  - removeTag
```
protected void removeTag(ERTag tag)
```
    Removes the tag from this item. This is the single method that to override if you need to perform some additional operations.
    
    Parameters:
    
    tag - the tag to remove
  - setTags
```
public void setTags(Object tags)
```
    Clears the current tags collection and sets the tag names for this object. Equivalent of calling addTags(tags, true).
    
    Parameters:
    
    tags - the tags to add (String to tokenize, NSArray<String>, etc)
  - tagNames
```
public NSArray<String> tagNames()
```
    Returns an array of strings containing the tag names applied to this object.
    
    Returns:
    
    an array of strings containing the tag names applied to this object
  - isTaggedWith
```
public boolean isTaggedWith(String tagName)
```
    Checks to see if this object has been tagged with the given tag name.
    
    Parameters:
    
    tagName - the tag name to check
    
    Returns:
    
    true if this eo is tagged with the given tag name, false otherwise
  - isTaggedWithAll
```
public boolean isTaggedWithAll(Object tags)
```
    Checks to see if this object has been tagged with all the given tags.
    
    Parameters:
    
    tags - the tags to add (String to tokenize, NSArray<String>, etc)
    
    Returns:
    
    true if this eo is tagged with all of the given tag names, false otherwise
  - isTaggedWithAny
```
public boolean isTaggedWithAny(Object tags)
```
    Checks to see if this object has been tagged with any of the given tags.
    
    Parameters:
    
    tags - the tags to add (String to tokenize, NSArray<String>, etc)
    
    Returns:
    
    true if this eo is tagged with any of the given tag names, false otherwise

Class ERTaggable<T extends ERXGenericRecord>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ERTaggable

Method Detail

hashCode

equals

taggable

item

taggableEntity

tags

clearTags

removeTags

removeTagNamed

addTagNamed

addTags

addTags

addTag

removeTag

setTags

tagNames

isTaggedWith

isTaggedWithAll

isTaggedWithAny