A Content Type defines the characteristics of a content - * item. Content management resources are registered to a content - * type, including the {@link com.arsdigita.cms.AuthoringKit - * Authoring Kit}, and {@link com.arsdigita.cms.Template - * templates}.
+ *A Content Type defines the characteristics of a content item. Content + * management resources are registered to a content type, including + * the {@link com.arsdigita.cms.AuthoringKit Authoring Kit}, and + * {@link com.arsdigita.cms.Template templates}.
* *Each content type is associated with a {@link
* com.arsdigita.domain.DomainObject domain object} and a {@link
@@ -362,7 +361,7 @@ public class ContentType extends ACSObject {
}
/**
- * Create an authoring kit to this content type. To save this authoring
+ * Create an authoring kit to this content type. To save this authoring
* kit, you need to call save() method on the
* returned AuthoringKit.
*
@@ -424,7 +423,8 @@ public class ContentType extends ACSObject {
}
/**
- * Add an ancestor to the list of descendants, if not already in the list
+ * Add an ancestor to the list of descendants, if not already in the list.
+ *
* @param newAncestor ID of the ancestor to add
*/
public void addAncestor(BigDecimal newAncestor) {
@@ -449,7 +449,8 @@ public class ContentType extends ACSObject {
}
/**
- * Remove an ancestor id from the list of descendants
+ * Remove an ancestor id from the list of descendants.
+ *
* @param ancestor ID to be removed
*/
public void delAncestor(BigDecimal ancestor) {
@@ -464,8 +465,8 @@ public class ContentType extends ACSObject {
// Delete the additional slash
ancestors.replace("//", "/");
- // If the list only contains a single slash,
- // we have just removed the last list entry, so the list is empty
+ // If the list only contains a single slash, we have just removed
+ // the last list entry, so the list is empty
if (ancestors.equals("/")) {
ancestors = "";
}
@@ -476,7 +477,8 @@ public class ContentType extends ACSObject {
}
/**
- * Get the list of ancestors
+ * Get the list of ancestors.
+ *
* @return
*/
public String getAncestors() {
@@ -484,7 +486,8 @@ public class ContentType extends ACSObject {
}
/**
- * Add a descendant to the list of descendants, if not already in list
+ * Add a descendant to the list of descendants, if not already in list.
+ *
* @param newDescendant ID of the descendant to add
*/
public void addDescendants(BigDecimal newDescendant) {
@@ -645,6 +648,11 @@ public class ContentType extends ACSObject {
return new ContentTypeCollection(dc);
}
+ /**
+ *
+ * @param ct
+ * @return
+ */
public static ContentTypeCollection getDescendantsOf(ContentType ct) {
ContentTypeCollection ctc = ContentType.getRegisteredContentTypes();
@@ -674,9 +682,9 @@ public class ContentType extends ACSObject {
private static List s_xsl = new ArrayList();
/**
+ * Registers an XSL file against a content type.
* NB this interface is liable to change.
*
- * Registers an XSL file against a content type.
* @param type the content type
* @param path the path relative to the server root
*/
@@ -685,9 +693,9 @@ public class ContentType extends ACSObject {
}
/**
+ * Unregisters an XSL file against a content type.
* NB this interface is liable to change.
*
- * Unregisters an XSL file against a content type.
* @param type the content type
* @param path the path relative to the server root
*/
@@ -698,24 +706,31 @@ public class ContentType extends ACSObject {
/**
* Gets an iterator of java.net.URL objects for
- * all registered XSL files
+ * all registered XSL files.
+ *
+ * @return
*/
public static Iterator getXSLFileURLs() {
return new EntryIterator(s_xsl.iterator());
}
+ /**
+ *
+ */
private static class EntryIterator implements Iterator {
- private Iterator m_inner;
+ private final Iterator m_inner;
public EntryIterator(Iterator inner) {
m_inner = inner;
}
+ @Override
public boolean hasNext() {
return m_inner.hasNext();
}
+ @Override
public Object next() {
XSLEntry entry = (XSLEntry) m_inner.next();
String path = entry.getPath();
@@ -730,15 +745,19 @@ public class ContentType extends ACSObject {
}
}
+ @Override
public void remove() {
m_inner.remove();
}
}
+ /**
+ *
+ */
private static class XSLEntry {
- private ContentType m_type;
- private String m_path;
+ private final ContentType m_type;
+ private final String m_path;
public XSLEntry(ContentType type,
String path) {
diff --git a/ccm-cms/src/com/arsdigita/cms/contenttypes/AbstractContentTypeLoader.java b/ccm-cms/src/com/arsdigita/cms/contenttypes/AbstractContentTypeLoader.java
index 0e7e7ac76..51ddbd49a 100755
--- a/ccm-cms/src/com/arsdigita/cms/contenttypes/AbstractContentTypeLoader.java
+++ b/ccm-cms/src/com/arsdigita/cms/contenttypes/AbstractContentTypeLoader.java
@@ -66,7 +66,10 @@ import org.apache.log4j.Logger;
**/
public abstract class AbstractContentTypeLoader extends PackageLoader {
- /** Logger instance for debugging */
+ /** Internal logger instance to faciliate debugging. Enable logging output
+ * by editing /WEB-INF/conf/log4j.properties int hte runtime environment
+ * and set com.arsdigita.cms.contenttypes.AbstractContentTypeLoader=DEBUG
+ * by uncommenting or adding the line. */
private static final Logger s_log = Logger.getLogger(
AbstractContentTypeLoader.class);
@@ -74,9 +77,11 @@ public abstract class AbstractContentTypeLoader extends PackageLoader {
*
* @param ctx
*/
+ @Override
public void run(final ScriptContext ctx) {
new KernelExcursion() {
+ @Override
protected void excurse() {
setEffectiveParty(Kernel.getSystemParty());
@@ -93,8 +98,8 @@ public abstract class AbstractContentTypeLoader extends PackageLoader {
private void createTypes(ScriptContext ctx) {
XMLContentTypeHandler handler = new XMLContentTypeHandler();
String[] contentTypes = getTypes();
- for (int i = 0; i < contentTypes.length; i++) {
- XML.parseResource(contentTypes[i], handler);
+ for (String contentType : contentTypes) {
+ XML.parseResource(contentType, handler);
}
List types = handler.getContentTypes();
@@ -110,8 +115,7 @@ public abstract class AbstractContentTypeLoader extends PackageLoader {
continue;
}
- LifecycleDefinitionCollection ldc =
- section.getLifecycleDefinitions();
+ LifecycleDefinitionCollection ldc = section.getLifecycleDefinitions();
LifecycleDefinition ld = null;
if (ldc.next()) {
ld = ldc.getLifecycleDefinition();
@@ -130,6 +134,13 @@ public abstract class AbstractContentTypeLoader extends PackageLoader {
}
}
+ /**
+ *
+ * @param section
+ * @param type
+ * @param ld
+ * @param wf
+ */
protected void prepareSection(final ContentSection section,
final ContentType type,
final LifecycleDefinition ld,
@@ -152,7 +163,7 @@ public abstract class AbstractContentTypeLoader extends PackageLoader {
*/
protected abstract String[] getTypes();
- /*
+ /**
*
*/
private boolean isLoadableInto(ContentSection section) {
@@ -185,17 +196,27 @@ public abstract class AbstractContentTypeLoader extends PackageLoader {
}
/**
- * This provides an easy way to subtypes to register default
- * templates during the loading. When this is used, it should
- * be called by the loader class by overriding prepareSection
+ * This provides an easy way to subtypes to register default templates
+ * during the loading. When this is used, it should be called by the
+ * loader class by overriding prepareSection.
+ *
+ * @param name
+ * @param label
+ * @param templateIs
+ * @param section
+ * @param type
+ * @param ld
+ * @param wf
+ * @return
*/
protected Template setDefaultTemplate(final String name,
- final String label,
- final InputStream templateIs,
- final ContentSection section,
- final ContentType type,
- final LifecycleDefinition ld,
- final WorkflowTemplate wf) {
+ final String label,
+ final InputStream templateIs,
+ final ContentSection section,
+ final ContentType type,
+ final LifecycleDefinition ld,
+ final WorkflowTemplate wf) {
+
final Template template = new Template();
template.setName(name);
template.setLabel(label);
diff --git a/ccm-cms/src/com/arsdigita/cms/ui/authoring/NewItemForm.java b/ccm-cms/src/com/arsdigita/cms/ui/authoring/NewItemForm.java
index 350dc35c3..6549f2beb 100755
--- a/ccm-cms/src/com/arsdigita/cms/ui/authoring/NewItemForm.java
+++ b/ccm-cms/src/com/arsdigita/cms/ui/authoring/NewItemForm.java
@@ -49,9 +49,9 @@ import java.math.BigDecimal;
import org.apache.log4j.Logger;
/**
- * A form which displays a select box of all content types available under the
- * given content section, and forwards to the item creation UI when the user
- * selects a content type to instantiate.
+ * A form element which displays a select box of all content types available
+ * under the given content section, and forwards to the item creation UI when
+ * the user selects a content type to instantiate.
*
* @author Stanislav Freidin (sfreidin@arsdigtia.com)
* @version $Revision: #12 $ $DateTime: 2004/08/17 23:15:09 $
diff --git a/ccm-core/src/com/arsdigita/bebop/Label.java b/ccm-core/src/com/arsdigita/bebop/Label.java
index a48b8e9a7..0137aba6d 100755
--- a/ccm-core/src/com/arsdigita/bebop/Label.java
+++ b/ccm-core/src/com/arsdigita/bebop/Label.java
@@ -43,15 +43,15 @@ import com.arsdigita.xml.Element;
*/
public class Label extends DescriptiveComponent implements Cloneable {
- private static final String NO_LABEL = "";
public static final String BOLD = "b";
public static final String ITALIC = "i";
// the default label
private GlobalizedMessage m_label;
// a requestlocal set of labels (to avoid printlisteners)
- private RequestLocal m_requestLabel = new RequestLocal();
+ private final RequestLocal m_requestLabel = new RequestLocal();
private String m_fontWeight;
+
/** The setting for output escaping affects how markup in the
* content is handled.
*
Label with empty text.
*/
public Label() {
- this(NO_LABEL);
+ // A kind of fallback (or a hack) here. Parameter label is taken as
+ // a key for some (unknown) Resource bundle. Because GlobalizedMessage
+ // will not find a corrresponding message it will display the key
+ // itself, 'faking' a globalized message.
+ m_label = new GlobalizedMessage(" ");
}
/**
* Creates a new Label with the specified (fixed) text.
*
* @param label the text to display
- * @deprecated refactor to use Label(GlobalizedMessage label) instad
+ * @deprecated refactor to use Label(GlobalizedMessage label) instead
*/
public Label(String label) {
this(label, true);
@@ -81,15 +85,14 @@ public class Label extends DescriptiveComponent implements Cloneable {
/**
* Creates a new Label with the specified text and
- * output escaping turned on if
- * escaping is
- * true.
+ * output escaping turned on if escaping is true.
*
* The setting for output escaping affects how markup in the
- * label is handled. For example: label is handled. For example:
+ * true if output escaping will be in effect;
@@ -127,8 +130,7 @@ public class Label extends DescriptiveComponent implements Cloneable {
/**
* Creates a new label with the specified text as GlobalizedMessage
- * and output escaping turned on if
- * escaping is
+ * and output escaping turned on if escaping is
* true.
If possible, derived classes should override - * {@link #getLabel()} instead, which is called from this method. As long as - * we don't have a static method to obtain ApplicationContext, this is a way - * to get the RequestContext (that is, to determine the locale). When - * ApplicationContext gets available, that will become the suggested way for - * overriding code to get context. + * dynamically generate the text of the label. Overriding code may need + * the page state. + *
+ * If possible, derived classes should override {@link #getLabel()} instead,
+ * which is called from this method. As long as we don't have a static
+ * method to obtain ApplicationContext, this is a way to get the
+ * RequestContext (to determine the locale). When ApplicationContext gets
+ * available, that will become the suggested way for overriding code to get
+ * context.
*
* @param state the current page state
* @return the string produced for this label
@@ -183,16 +188,16 @@ public class Label extends DescriptiveComponent implements Cloneable {
return (String) getGlobalizedMessage(state).localize(state.getRequest());
}
- /**
- * .
- *
- * This method may be overridden to dynamically generate the default text of
- * the label.
- *
- * @return the string produced for this label.
- *
- * @deprecated Use {@link #getGlobalizedMessage()}
- */
+ // /**
+ // * .
+ // *
+ // * This method may be overridden to dynamically generate the default text of
+ // * the label.
+ // *
+ // * @return the string produced for this label.
+ // *
+ // * @deprecated Use {@link #getGlobalizedMessage()}
+ // */
// Conflicts with Super's getLabel message of type GlobalizedMessage. But isn't
// needed anyway. Should deleted as soon as the refactoring of Label is
// completed (i.e. any string Label ironed out).
@@ -256,8 +261,10 @@ public class Label extends DescriptiveComponent implements Cloneable {
if (label == null || label.length() == 0) {
label = " ";
}
- // Seems to be quite useless. label is taken as a key for some (unknown)
- // Resource bundle.
+ // A kind of fallback (or a hack) here. Parameter label is taken as
+ // a key for some (unknown) Resource bundle. Because GlobalizedMessage
+ // will not find a corrresponding message it will display the key
+ // itself, 'faking' a globalized message.
setLabel(new GlobalizedMessage(label), state);
}
@@ -319,9 +326,8 @@ public class Label extends DescriptiveComponent implements Cloneable {
/**
* Adds a print listener. Only one print listener can be set for a label,
- * since the
- * PrintListener is expected to modify the target of the
- * PrintEvent.
+ * since the PrintListener is expected to modify the target
+ * of the PrintEvent.
*
* @param listener the print listener
* @throws IllegalArgumentException if listener is null.
@@ -341,8 +347,8 @@ public class Label extends DescriptiveComponent implements Cloneable {
}
/**
- * Removes a previously added print listener. If
- * listener is not the listener that was added with {@link #addPrintListener
+ * Removes a previously added print listener. If listener is
+ * not the listener that was added with {@link #addPrintListener
* addPrintListener}, an IllegalArgumentException will be thrown.
*
* @param listener the listener that was added with
@@ -408,10 +414,10 @@ public class Label extends DescriptiveComponent implements Cloneable {
}
/*
- * This may break with normal JDOM. We may need to have a node
- * for the case where there is no weight. The problem comes in that
- * setText *may* kill the other content in the node. It will kill the
- * other text, so it may be a good idea anyways.
+ * This may break with normal JDOM. We may need to have a node for
+ * the case where there is no weight. The problem comes in that
+ * setText *may* kill the other content in the node. It will kill
+ * the other text, so it may be a good idea anyways.
*/
label.setText(target.getLabel(state));
}