/**
* Weblog Category.
*
* @hibernate.cache usage="read-write"
* @hibernate.class lazy="true" table="weblogcategory"
*/
public class WeblogCategory implements Serializable, Comparable {
public static final long serialVersionUID = 1435782148712018954L;
private static Log log = LogFactory.getLog(WeblogCategory.class);
// attributes
private String id = UUIDGenerator.generateUUID();
private String name = null;
private String description = null;
private String image = null;
private String path = null;
// associations
private Weblog website = null;
private WeblogCategory parentCategory = null;
private Set childCategories = new HashSet();
public WeblogCategory() {}
public WeblogCategory(
Weblog website, WeblogCategory parent, String name, String description, String image) {
this.name = name;
this.description = description;
this.image = image;
this.website = website;
this.parentCategory = parent;
// calculate path
if (parent == null) {
this.path = "/";
} else if ("/".equals(parent.getPath())) {
this.path = "/" + name;
} else {
this.path = parent.getPath() + "/" + name;
}
}
// ------------------------------------------------------- Good citizenship
public String toString() {
StringBuffer buf = new StringBuffer();
buf.append("{");
buf.append(this.id);
buf.append(", ").append(this.path);
buf.append("}");
return buf.toString();
}
public boolean equals(Object other) {
if (other == null) return false;
if (other instanceof WeblogCategory) {
WeblogCategory o = (WeblogCategory) other;
return new EqualsBuilder()
.append(getPath(), o.getPath())
// .append(getWebsite(), o.getWebsite())
.isEquals();
}
return false;
}
public int hashCode() {
return new HashCodeBuilder()
.append(getPath())
// .append(getWebsite())
.toHashCode();
}
/** @see java.lang.Comparable#compareTo(java.lang.Object) */
public int compareTo(Object o) {
WeblogCategory other = (WeblogCategory) o;
return getName().compareTo(other.getName());
}
/**
* Database surrogate key.
*
* @hibernate.id column="id" generator-class="assigned"
*/
public String getId() {
return this.id;
}
public void setId(String id) {
this.id = id;
}
/**
* The display name for this category.
*
* @hibernate.property column="name" non-null="true" unique="false"
*/
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
/**
* A full description for this category.
*
* @hibernate.property column="description" non-null="true" unique="false"
*/
public String getDescription() {
return this.description;
}
public void setDescription(String description) {
this.description = description;
}
/**
* An image icon to represent this category.
*
* @hibernate.property column="image" non-null="true" unique="false"
*/
public String getImage() {
return this.image;
}
public void setImage(String image) {
this.image = image;
}
/**
* The full path to this category in the hierarchy.
*
* @hibernate.property column="path" non-null="true" unique="false"
*/
public String getPath() {
return this.path;
}
public void setPath(String path) {
this.path = path;
}
/**
* Get the weblog which owns this category.
*
* @hibernate.many-to-one column="websiteid" cascade="none" not-null="true"
*/
public Weblog getWebsite() {
return website;
}
public void setWebsite(Weblog website) {
this.website = website;
}
/**
* Get parent category, or null if category is root of hierarchy.
*
* @hibernate.many-to-one column="parentid" cascade="none" not-null="false"
*/
public WeblogCategory getParent() {
return this.parentCategory;
}
public void setParent(WeblogCategory parent) {
this.parentCategory = parent;
}
/**
* Get child categories of this category.
*
* @hibernate.collection-key column="parentid"
* @hibernate.collection-one-to-many class="org.apache.roller.weblogger.pojos.WeblogCategory"
* @hibernate.set lazy="true" inverse="true" cascade="delete" order-by="name"
*/
public Set getWeblogCategories() {
return this.childCategories;
}
private void setWeblogCategories(Set cats) {
this.childCategories = cats;
}
/**
* Retrieve all weblog entries in this category and, optionally, include weblog entries all
* sub-categories.
*
* @param subcats True if entries from sub-categories are to be returned.
* @return List of WeblogEntryData objects.
* @throws WebloggerException
*/
public List retrieveWeblogEntries(boolean subcats) throws WebloggerException {
WeblogEntryManager wmgr = WebloggerFactory.getWeblogger().getWeblogEntryManager();
return wmgr.getWeblogEntries(this, subcats);
}
/** Add a category as a child of this category. */
public void addCategory(WeblogCategory category) {
// make sure category is not null
if (category == null || category.getName() == null) {
throw new IllegalArgumentException("Category cannot be null and must have a valid name");
}
// make sure we don't already have a category with that name
if (this.hasCategory(category.getName())) {
throw new IllegalArgumentException("Duplicate category name '" + category.getName() + "'");
}
// set ourselves as the parent of the category
category.setParent(this);
// add it to our list of child categories
getWeblogCategories().add(category);
}
/**
* Does this category have a child category with the specified name?
*
* @param name The name of the category to check for.
* @return boolean true if child category exists, false otherwise.
*/
public boolean hasCategory(String name) {
Iterator cats = this.getWeblogCategories().iterator();
WeblogCategory cat = null;
while (cats.hasNext()) {
cat = (WeblogCategory) cats.next();
if (name.equals(cat.getName())) {
return true;
}
}
return false;
}
/** Is this category a descendent of the other category? */
public boolean descendentOf(WeblogCategory ancestor) {
// if this is a root node then we can't be a descendent
if (getParent() == null) {
return false;
} else {
// if our path starts with our parents path then we are a descendent
return this.path.startsWith(ancestor.getPath());
}
}
/**
* Determine if category is in use. Returns true if any weblog entries use this category or any of
* it's subcategories.
*/
public boolean isInUse() {
try {
return WebloggerFactory.getWeblogger().getWeblogEntryManager().isWeblogCategoryInUse(this);
} catch (WebloggerException e) {
throw new RuntimeException(e);
}
}
// convenience method for updating the category name, which triggers a path tree rebuild
public void updateName(String newName) throws WebloggerException {
// update name
setName(newName);
// calculate path
if (getParent() == null) {
setPath("/");
} else if ("/".equals(getParent().getPath())) {
setPath("/" + getName());
} else {
setPath(getParent().getPath() + "/" + getName());
}
// update path tree for all children
updatePathTree(this);
}
// updates the paths of all descendents of the given category
public static void updatePathTree(WeblogCategory cat) throws WebloggerException {
log.debug("Updating path tree for category " + cat.getPath());
WeblogCategory childCat = null;
Iterator childCats = cat.getWeblogCategories().iterator();
while (childCats.hasNext()) {
childCat = (WeblogCategory) childCats.next();
log.debug("OLD child category path was " + childCat.getPath());
// update path and save
if ("/".equals(cat.getPath())) {
childCat.setPath("/" + childCat.getName());
} else {
childCat.setPath(cat.getPath() + "/" + childCat.getName());
}
WebloggerFactory.getWeblogger().getWeblogEntryManager().saveWeblogCategory(childCat);
log.debug("NEW child category path is " + childCat.getPath());
// then make recursive call to update this cats children
updatePathTree(childCat);
}
}
}
/**
* Name and value pair associated with a user object.
*
* @author Tatyana Tokareva
*/
public class UserAttribute implements Serializable {
public static final long serialVersionUID = -6354583200913127874L;
private String id = UUIDGenerator.generateUUID();
private String userName;
private String attrName;
private String attrValue;
public static enum Attributes {
OPENID_URL("openid.url");
private Attributes(String name) {
this.name = name;
}
private final String name;
@Override
public String toString() {
return name;
}
public String get() {
return name.toString();
}
}
public UserAttribute() {
// required for JPA
}
public UserAttribute(String userName, String attrName, String attrValue) {
this.userName = userName;
this.attrName = attrName;
this.attrValue = attrValue;
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getUserName() {
return userName;
}
public void setUserName(String userId) {
this.userName = userId;
}
public String getName() {
return attrName;
}
public void setName(String attrName) {
this.attrName = attrName;
}
public String getValue() {
return attrValue;
}
public void setValue(String attrValue) {
this.attrValue = attrValue;
}
public String toString() {
StringBuffer buf = new StringBuffer();
buf.append("{");
buf.append(this.id);
buf.append(", ").append(this.userName);
buf.append(", ").append(this.attrName);
buf.append(", ").append(this.attrValue);
buf.append("}");
return buf.toString();
}
public boolean equals(Object other) {
if (other == this) return true;
if (other instanceof UserRole != true) return false;
UserAttribute o = (UserAttribute) other;
return new EqualsBuilder()
.append(getUserName(), o.getUserName())
.append(getName(), o.getName())
.append(getValue(), o.getValue())
.isEquals();
}
public int hashCode() {
return new HashCodeBuilder()
.append(getUserName())
.append(getName())
.append(getValue())
.toHashCode();
}
}