true. Defaults to
* {@link SimpleXMLGenerator.ADAPTER_CONTEXT}.
*/
- private String m_specializeObjectsContext =
- SimpleXMLGenerator.ADAPTER_CONTEXT;
+ private String m_specializeObjectsContext = SimpleXMLGenerator.ADAPTER_CONTEXT;
private boolean m_wrapAttributes = false;
private boolean m_navItems = true;
@@ -70,31 +65,43 @@ public class DataCollectionRenderer extends LockableImpl {
addAttribute("id");
}
- public void addAttribute(String name) {
+ public void addAttribute(final String name) {
Assert.isUnlocked(this);
m_attributes.add(name);
}
-
- public void addProperty(DataCollectionPropertyRenderer pr) {
+
+ public void addProperty(final DataCollectionPropertyRenderer pr) {
Assert.isUnlocked(this);
m_properties.add(pr);
}
-
- public void setPageSize(int pageSize) {
+
+ protected int getPageSize() {
+ return m_pageSize;
+ }
+
+ public void setPageSize(final int pageSize) {
Assert.isUnlocked(this);
m_pageSize = pageSize;
}
+ protected boolean getNavItems() {
+ return m_navItems;
+ }
+
/**
* Specify whether to include the items for navigation that are within
* same category.
* This flag toggles the generation of nav:item xml elements.
*/
- public void setNavItems(boolean navItems) {
+ public void setNavItems(final boolean navItems) {
m_navItems = navItems;
}
+
+ protected boolean isSpecializeObjects() {
+ return m_specializeObjects;
+ }
- public void setSpecializeObjects(boolean specializeObjects) {
+ public void setSpecializeObjects(final boolean specializeObjects) {
Assert.isUnlocked(this);
m_specializeObjects = specializeObjects;
}
@@ -110,11 +117,11 @@ public class DataCollectionRenderer extends LockableImpl {
*
* @param context The adapter context.
*/
- public void setSpecializeObjectsContext(String context) {
+ public void setSpecializeObjectsContext(final String context) {
m_specializeObjectsContext = context;
}
- public void setWrapAttributes(boolean wrapAttributes) {
+ public void setWrapAttributes(final boolean wrapAttributes) {
Assert.isUnlocked(this);
m_wrapAttributes = wrapAttributes;
}
@@ -122,17 +129,22 @@ public class DataCollectionRenderer extends LockableImpl {
public List getAttributes() {
return m_attributes;
}
+
+ public List getProperties() {
+ return m_properties;
+ }
/**
* @param objects
- * @param pageNumber current page, starting from 1
+ * @param pageNum
*
* @return
*/
- public Element generateXML(DataCollection objects,
- int pageNumber) {
+ public Element generateXML(final DataCollection objects, final int pageNum) {
Assert.isLocked(this);
+ int pageNumber = pageNum;
+
// Quasimodo: Begin
// If objects is null or empty, do not insert objectList-element
// but do insert noContent-element and return immediately
@@ -141,19 +153,18 @@ public class DataCollectionRenderer extends LockableImpl {
}
// Quasimodo: End
- Element content = Navigation.newElement("objectList");
+ final Element content = Navigation.newElement("objectList");
//Return the empty nav:item & nav:paginator tags.
// Quasimodo: Why should I??? There is no need for a paginator if there aren't any elements
if (!m_navItems) {
- Element paginator = Navigation.newElement("paginator");
+ final Element paginator = Navigation.newElement("paginator");
content.addContent(paginator);
return content;
}
- long objectCount = objects.size();
- int pageCount = (int) Math.ceil((double) objectCount
- / (double) m_pageSize);
+ final long objectCount = objects.size();
+ final int pageCount = (int) Math.ceil((double) objectCount / (double) m_pageSize);
if (pageNumber < 1) {
pageNumber = 1;
@@ -163,28 +174,27 @@ public class DataCollectionRenderer extends LockableImpl {
pageNumber = (pageCount == 0 ? 1 : pageCount);
}
- long begin = ((pageNumber - 1) * m_pageSize);
- int count = (int) Math.min(m_pageSize, (objectCount - begin));
- long end = begin + count;
+ final long begin = ((pageNumber - 1) * m_pageSize);
+ final int count = (int) Math.min(m_pageSize, (objectCount - begin));
+ final long end = begin + count;
if (count != 0) {
- objects.setRange(new Integer((int) begin + 1),
- new Integer((int) end + 1));
+ objects.setRange((int) begin + 1, (int) end + 1);
}
- Element paginator = Navigation.newElement("paginator");
+ final Element paginator = Navigation.newElement("paginator");
// Quasimodo: Begin
// Copied from com.arsdigita.search.ui.ResultPane
- String pageParam = "pageNumber";
+ final String pageParam = "pageNumber";
- URL url = Web.getContext().getRequestURL();
- ParameterMap map = new ParameterMap();
+ final URL url = Web.getContext().getRequestURL();
+ final ParameterMap map = new ParameterMap();
if (url.getParameterMap() != null) {
- Iterator current = url.getParameterMap().keySet().iterator();
+ final Iterator current = url.getParameterMap().keySet().iterator();
while (current.hasNext()) {
- String key = (String) current.next();
+ final String key = (String) current.next();
if (key.equals(pageParam)) {
continue;
}
@@ -197,47 +207,48 @@ public class DataCollectionRenderer extends LockableImpl {
toString());
// Quasimodo: End
- paginator.addAttribute("pageNumber", new Long(pageNumber).toString());
- paginator.addAttribute("pageCount", new Long(pageCount).toString());
- paginator.addAttribute("pageSize", new Long(m_pageSize).toString());
- paginator.addAttribute("objectBegin", new Long(begin + 1).toString());
- paginator.addAttribute("objectEnd", new Long(end).toString());
- paginator.addAttribute("objectCount", new Long(objectCount).toString());
+ paginator.addAttribute("pageNumber", Long.toString(pageNumber));
+ paginator.addAttribute("pageCount", Long.toString(pageCount));
+ paginator.addAttribute("pageSize", Long.toString(m_pageSize));
+ paginator.addAttribute("objectBegin", Long.toString(begin + 1));
+ paginator.addAttribute("objectEnd", Long.toString(end));
+ paginator.addAttribute("objectCount", Long.toString(objectCount));
content.addContent(paginator);
int index = 0;
while (objects.next()) {
- DataObject dobj = objects.getDataObject();
+ final DataObject dobj = objects.getDataObject();
ACSObject object = null;
if (m_specializeObjects) {
object = (ACSObject) DomainObjectFactory.newInstance(dobj);
if (object == null) {
- s_log.error(String.format("Failed to specialize object with with id %s. Skiping object.", dobj.getOID().toString()));
+ s_log.error(String.format("Failed to specialize object with with id %s. Skiping object.", dobj.
+ getOID().toString()));
continue;
} else {
s_log.debug("Specializing successful.");
}
}
- Element item = Navigation.newElement(content, "item");
+ final Element item = Navigation.newElement(content, "item");
- Iterator attributes = m_attributes.iterator();
+ final Iterator attributes = m_attributes.iterator();
while (attributes.hasNext()) {
- String name = (String) attributes.next();
- String[] paths = StringUtils.split(name, '.');
+ final String name = (String) attributes.next();
+ final String[] paths = StringUtils.split(name, '.');
outputValue(item, dobj, name, paths, 0);
}
- Iterator properties = m_properties.iterator();
+ final Iterator properties = m_properties.iterator();
while (properties.hasNext()) {
- DataCollectionPropertyRenderer property = (DataCollectionPropertyRenderer) properties.next();
+ final DataCollectionPropertyRenderer property = (DataCollectionPropertyRenderer) properties.next();
property.render(objects, item);
}
- Element path = Navigation.newElement(item, "path");
+ final Element path = Navigation.newElement(item, "path");
path.setText(getStableURL(dobj, object));
//item.addContent(path);
-
+
generateItemXML(item, dobj, object, index);
index++;
@@ -247,22 +258,23 @@ public class DataCollectionRenderer extends LockableImpl {
return content;
}
- protected String getStableURL(DataObject dobj, ACSObject obj) {
- OID oid = new OID((String) dobj.get(ACSObject.OBJECT_TYPE),
- dobj.get(ACSObject.ID));
+ protected String getStableURL(final DataObject dobj, final ACSObject obj) {
+ final OID oid = new OID((String) dobj.get(ACSObject.OBJECT_TYPE), dobj.get(ACSObject.ID));
return Navigation.redirectURL(oid);
}
- private void outputValue(final Element item, final Object value,
- final String name,
- final String[] paths, final int depth) {
+ protected void outputValue(final Element item,
+ final Object value,
+ final String name,
+ final String[] paths,
+ final int depth) {
if (null == value) {
return;
}
if (value instanceof DataAssociation) {
- DataAssociation assoc = (DataAssociation) value;
- DataAssociationCursor cursor = assoc.cursor();
+ final DataAssociation assoc = (DataAssociation) value;
+ final DataAssociationCursor cursor = assoc.cursor();
while (cursor.next()) {
outputValue(item, cursor.getDataObject(), name, paths, depth);
@@ -271,40 +283,34 @@ public class DataCollectionRenderer extends LockableImpl {
cursor.close();
} else if (value instanceof DataObject) {
try {
- Object newValue = ((DataObject) value).get(paths[depth]);
+ final Object newValue = ((DataObject) value).get(paths[depth]);
outputValue(item, newValue, name, paths, depth + 1);
} catch (PersistenceException ex) {
valuePersistenceError(ex, paths, depth);
}
} else if (depth == paths.length) {
- Element attribute = Navigation.newElement("attribute");
+ final Element attribute = Navigation.newElement("attribute");
attribute.addAttribute("name", name);
attribute.setText(value.toString());
// Special handling of Date - see ccm-core/src/com/arsdigita/domain/DomainObjectXMLRenderer.java
if (value instanceof Date) {
- Date date = (Date) value;
- Calendar calDate = Calendar.getInstance();
+ final Date date = (Date) value;
+ final Calendar calDate = Calendar.getInstance();
calDate.setTime(date);
- attribute.addAttribute("year", Integer.toString(calDate.get(
- Calendar.YEAR)));
- attribute.addAttribute("month", Integer.toString(calDate.get(
- Calendar.MONTH) + 1));
- attribute.addAttribute("day", Integer.toString(calDate.get(
- Calendar.DAY_OF_MONTH)));
- attribute.addAttribute("hour", Integer.toString(calDate.get(
- Calendar.HOUR_OF_DAY)));
- attribute.addAttribute("minute", Integer.toString(calDate.get(
- Calendar.MINUTE)));
- attribute.addAttribute("second", Integer.toString(calDate.get(
- Calendar.SECOND)));
+ attribute.addAttribute("year", Integer.toString(calDate.get(Calendar.YEAR)));
+ attribute.addAttribute("month", Integer.toString(calDate.get(Calendar.MONTH) + 1));
+ attribute.addAttribute("day", Integer.toString(calDate.get(Calendar.DAY_OF_MONTH)));
+ attribute.addAttribute("hour", Integer.toString(calDate.get(Calendar.HOUR_OF_DAY)));
+ attribute.addAttribute("minute", Integer.toString(calDate.get(Calendar.MINUTE)));
+ attribute.addAttribute("second", Integer.toString(calDate.get(Calendar.SECOND)));
// Quasimodo: BEGIN
// Add attributes for date and time
- Locale negLocale = com.arsdigita.globalization.GlobalizationHelper.getNegotiatedLocale();
- DateFormat dateFormatter = DateFormat.getDateInstance(DateFormat.MEDIUM, negLocale);
- DateFormat longDateFormatter = DateFormat.getDateInstance(DateFormat.LONG, negLocale);
- DateFormat timeFormatter = DateFormat.getTimeInstance(DateFormat.SHORT, negLocale);
+ final Locale negLocale = com.arsdigita.globalization.GlobalizationHelper.getNegotiatedLocale();
+ final DateFormat dateFormatter = DateFormat.getDateInstance(DateFormat.MEDIUM, negLocale);
+ final DateFormat longDateFormatter = DateFormat.getDateInstance(DateFormat.LONG, negLocale);
+ final DateFormat timeFormatter = DateFormat.getTimeInstance(DateFormat.SHORT, negLocale);
attribute.addAttribute("date", dateFormatter.format(date));
attribute.addAttribute("longDate", longDateFormatter.format(date));
attribute.addAttribute("time", timeFormatter.format(date));
@@ -318,9 +324,8 @@ public class DataCollectionRenderer extends LockableImpl {
}
}
- private void valuePersistenceError(PersistenceException ex,
- String[] paths, int depth) {
- StringBuffer msg = new StringBuffer();
+ private void valuePersistenceError(final PersistenceException exception, final String[] paths, final int depth) {
+ final StringBuffer msg = new StringBuffer(30);
msg.append("Attribute ");
for (int i = 0; i <= depth; i++) {
msg.append(paths[i]);
@@ -330,16 +335,15 @@ public class DataCollectionRenderer extends LockableImpl {
}
msg.append(" doesn't exist");
- if (null == ex) {
+ if (null == exception) {
s_log.warn(msg.toString());
} else {
- s_log.warn(msg.toString(), ex);
+ s_log.warn(msg.toString(), exception);
}
}
- protected void generateItemXML(Element item,
- DataObject dobj,
- ACSObject obj,
- int index) {
+ protected void generateItemXML(final Element item, final DataObject dobj, final ACSObject obj, final int index) {
+
}
+
}
diff --git a/ccm-navigation/src/com/arsdigita/navigation/cms/CategorisedDataCollectionDefinition.java b/ccm-navigation/src/com/arsdigita/navigation/cms/CategorisedDataCollectionDefinition.java
new file mode 100644
index 000000000..1480cff4f
--- /dev/null
+++ b/ccm-navigation/src/com/arsdigita/navigation/cms/CategorisedDataCollectionDefinition.java
@@ -0,0 +1,44 @@
+package com.arsdigita.navigation.cms;
+
+import com.arsdigita.categorization.Category;
+import com.arsdigita.london.terms.Domain;
+import com.arsdigita.navigation.NavigationModel;
+import com.arsdigita.persistence.DataCollection;
+import com.arsdigita.persistence.Filter;
+
+/**
+ * An extension to the {@link CMSDataCollectionDefinition}. With this definition it is possible to filter an object
+ * list using a second category system/terms domain. This class is designed to be used together with the
+ * {@link CategorisedDataCollectionRenderer} which displays the objects in a list with several sections.
+ *
+ * @author Jens Pelzetter + * An extended {@code DataCollectionRenderer} which displays a object list split into several sections. The sections + * are created using a second category system/term domain set using the {@link #setTermDomain(java.lang.String)} + * method in the JSP template. This renderer is designed to be used together with the + * {@link CategorisedDataCollectionRenderer}. To use them, a special JSP template is required. More specificly a JSP + * template using these two class would look like this (only relevant parts shown): + *
+ *