com.erudika.para.core.utils

Class CoreUtils

java.lang.Object

com.erudika.para.core.utils.CoreUtils

All Implemented Interfaces:

InitializeListener, EventListener

@Singleton
public final class CoreUtils
extends Object
implements InitializeListener

Provides some the basic functionality for domain objects.

Author:

Alex Bogdanovski [alex@erudika.com]

See Also:

ParaObject

Constructor Summary

Constructors

Constructor and Description
CoreUtils(DAO dao, Search search, Cache cache) Default constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	addTags(List<String> objectTags, String... tag) Adds any number of tags to the set of tags.
Long	countChildren(ParaObject obj, String type2) Count the total number of child objects for this object.
Long	countLinks(ParaObject obj, String type2) Count the total number of links between this object and another type of object.
void	deleteChildren(ParaObject obj, String type2) Deletes all child objects permanently.
Cache	getCache()
<P extends ParaObject> List<P>	getChildren(ParaObject obj, String type2, Pager... pager) Returns all child objects linked to this object.
<P extends ParaObject> List<P>	getChildren(ParaObject obj, String type2, String field, String term, Pager... pager) Returns all child objects linked to this object.
<P extends ParaObject> P	getCreator(ParaObject obj) The user object of the creator.
DAO	getDao()
static CoreUtils	getInstance() Provides a default instance using fake DAO and Search implementations.
<P extends ParaObject> List<P>	getLinkedObjects(ParaObject obj, String type2, Pager... pager) Returns all objects linked to the given one.
List<Linker>	getLinks(ParaObject obj, String type2, Pager... pager) Returns a list of all Linker objects for a given object.
String	getName(String name, String id)
String	getObjectURI(ParaObject obj)
<P extends ParaObject> P	getParent(ParaObject obj) The parent object.
Search	getSearch()
boolean	isLinked(ParaObject obj, ParaObject toObj) Checks if a given object is linked to this one.
boolean	isLinked(ParaObject obj, String type2, String id2) Checks if this object is linked to another.
String	link(ParaObject obj, String id2) Links an object to this one in a many-to-many relationship.
void	onInitialize() Code to execute right after initialization.
String	overwrite(ParaObject obj) Creates the object again (use with caution!).
String	overwrite(String appid, ParaObject obj) Creates the object again (use with caution!).
List<String>	removeTags(List<String> objectTags, String... tag) Removes a tag from the set of tags.
void	setCache(Cache cache)
void	setDao(DAO dao)
void	setSearch(Search search)
void	unlink(ParaObject obj, String type2, String id2) Unlinks an object from this one.
void	unlinkAll(ParaObject obj) Unlinks all objects that are linked to this one.
boolean	vote(ParaObject votable, String userid, Votable.VoteValue upDown) Casts a vote on a given object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoreUtils

public CoreUtils(DAO dao,
                 Search search,
                 Cache cache)

Default constructor.

Parameters:

dao - a DAO object

search - a Search object

cache - a Cache object

Method Detail

onInitialize

public void onInitialize()

Description copied from interface: InitializeListener

Code to execute right after initialization.

Specified by:

onInitialize in interface InitializeListener

getInstance

public static CoreUtils getInstance()

Provides a default instance using fake DAO and Search implementations.

Returns:

an instance of this class

getDao

public DAO getDao()

setDao

public void setDao(DAO dao)

getSearch

public Search getSearch()

setSearch

public void setSearch(Search search)

getCache

public Cache getCache()

setCache

public void setCache(Cache cache)

getObjectURI

public String getObjectURI(ParaObject obj)

getName

public String getName(String name,
                      String id)

overwrite

public String overwrite(ParaObject obj)

Creates the object again (use with caution!). Same as DAO.create(com.erudika.para.core.ParaObject).

Parameters:

obj - an object

Returns:

the object id or null

overwrite

public String overwrite(String appid,
                        ParaObject obj)

Creates the object again (use with caution!). Same as DAO.create(java.lang.String, com.erudika.para.core.ParaObject).

Parameters:

appid - the app id

obj - an object

Returns:

the object id or null

addTags

public List<String> addTags(List<String> objectTags,
                            String... tag)

Adds any number of tags to the set of tags.

Parameters:

tag - a tag, must not be null or empty

objectTags - the object tags

Returns:

a new list of tags

removeTags

public List<String> removeTags(List<String> objectTags,
                               String... tag)

Removes a tag from the set of tags.

Parameters:

tag - a tag, must not be null or empty

objectTags - the object

Returns:

a new list of tags

link

public String link(ParaObject obj,
                   String id2)

Links an object to this one in a many-to-many relationship. Only a link is created. Objects are left untouched. The type of the second object is automatically determined on read.

Parameters:

id2 - link to the object with this id

obj - the object to execute this method on

Returns:

the id of the Linker object that is created

unlink

public void unlink(ParaObject obj,
                   String type2,
                   String id2)

Unlinks an object from this one. Only a link is deleted. Objects are left untouched.

Parameters:

type2 - the other type

obj - the object to execute this method on

id2 - the other id

unlinkAll

public void unlinkAll(ParaObject obj)

Unlinks all objects that are linked to this one.

Parameters:

obj - the object to execute this method on Deletes all Linker objects. Only the links are deleted. Objects are left untouched.

getLinks

public List<Linker> getLinks(ParaObject obj,
                             String type2,
                             Pager... pager)

Returns a list of all Linker objects for a given object.

Parameters:

obj - the object to execute this method on

type2 - the other type

pager - a Pager

Returns:

a list of Linker objects

isLinked

public boolean isLinked(ParaObject obj,
                        String type2,
                        String id2)

Checks if this object is linked to another.

Parameters:

type2 - the other type

id2 - the other id

obj - the object to execute this method on

Returns:

true if the two are linked

isLinked

public boolean isLinked(ParaObject obj,
                        ParaObject toObj)

Checks if a given object is linked to this one.

Parameters:

toObj - the other object

obj - the object to execute this method on

Returns:

true if linked

countLinks

public Long countLinks(ParaObject obj,
                       String type2)

Count the total number of links between this object and another type of object.

Parameters:

type2 - the other type of object

obj - the object to execute this method on

Returns:

the number of links for the given object

countChildren

public Long countChildren(ParaObject obj,
                          String type2)

Count the total number of child objects for this object.

Parameters:

type2 - the type of the other object

obj - the object to execute this method on

Returns:

the number of links

getChildren

public <P extends ParaObject> List<P> getChildren(ParaObject obj,
                                                  String type2,
                                                  Pager... pager)

Returns all child objects linked to this object.

Type Parameters:

P - the type of children

Parameters:

type2 - the type of children to look for

obj - the object to execute this method on

pager - a Pager

Returns:

a list of ParaObject in a one-to-many relationship with this object

getChildren

public <P extends ParaObject> List<P> getChildren(ParaObject obj,
                                                  String type2,
                                                  String field,
                                                  String term,
                                                  Pager... pager)

Returns all child objects linked to this object.

Type Parameters:

P - the type of children

Parameters:

type2 - the type of children to look for

field - the field name to use as filter

term - the field value to use as filter

obj - the object to execute this method on

pager - a Pager

Returns:

a list of ParaObject in a one-to-many relationship with this object

deleteChildren

public void deleteChildren(ParaObject obj,
                           String type2)

Deletes all child objects permanently.

Parameters:

obj - the object to execute this method on

type2 - the children's type.

getLinkedObjects

public <P extends ParaObject> List<P> getLinkedObjects(ParaObject obj,
                                                       String type2,
                                                       Pager... pager)

Returns all objects linked to the given one. Only applicable to many-to-many relationships.

Type Parameters:

P - type of linked objects

Parameters:

type2 - type of linked objects to search for

obj - the object to execute this method on

pager - a Pager

Returns:

a list of linked objects

getParent

public <P extends ParaObject> P getParent(ParaObject obj)

The parent object.

Type Parameters:

P - type of linked objects

Parameters:

obj - find the parent of this object

Returns:

the parent or null if obj.getParentid() is null

getCreator

public <P extends ParaObject> P getCreator(ParaObject obj)

The user object of the creator.

Type Parameters:

P - type of linked objects

Parameters:

obj - find the creator of this object

Returns:

the user who created this or null if obj.getCreatorid() is null

See Also:

User

vote

public boolean vote(ParaObject votable,
                    String userid,
                    Votable.VoteValue upDown)

Casts a vote on a given object.

Parameters:

votable - the object to vote on

userid - the voter

upDown - up or down

Returns:

true if the vote was successful