LibreCCM
/
libreccm-legacy
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Corrections of the JavaDoc comments of various classes which were causing warnings when creating the JavaDoc. 

git-svn-id: https://svn.libreccm.org/ccm/trunk@2507 8810af33-2d31-482b-a856-94f89814c4df
master
jensp 2014-02-05 09:16:48 +00:00
parent 5659f0bdb4
commit f23dfe7b10
17 changed files with 379 additions and 441 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
ccm-atoz/src/com/arsdigita/atoz/AtoZConfig.java
View File

@ -38,15 +38,15 @@ public class AtoZConfig extends AbstractConfig {
/** A logger instance to assist debugging. */ /** A logger instance to assist debugging. */
private static final Logger s_log = Logger.getLogger(AtoZConfig.class); private static final Logger s_log = Logger.getLogger(AtoZConfig.class);
/** Singelton config object. */ /** Singleton config object. */
private static AtoZConfig s_conf; private static AtoZConfig s_conf;
/** /**
* Gain a AtoZConfig object. * Gain a AtoZConfig object.
* *
* Singelton pattern, don't instantiate a config object using the * Singleton pattern, don't instantiate a config object using the
* constructor directly! * constructor directly!
* @return * @return The sole and only instance of this class.
*/ */
public static synchronized AtoZConfig getConfig() { public static synchronized AtoZConfig getConfig() {
if (s_conf == null) { if (s_conf == null) {
@ -102,7 +102,8 @@ public class AtoZConfig extends AbstractConfig {
/** /**
* Provides access to the traversal adapter as stream. * Provides access to the traversal adapter as stream.
* @return *
* @return InputStream of the traversal adapter.
*/ */
InputStream getTraversalAdapters() { InputStream getTraversalAdapters() {
return (InputStream)get(m_adapters); return (InputStream)get(m_adapters);

2
ccm-atoz/src/com/arsdigita/atoz/CategoryProvider.java
View File

@ -109,7 +109,7 @@ public class CategoryProvider extends AtoZProvider {
* @param title * @param title
* @param description * @param description
* @param isCompound * @param isCompound
* @return * @return A new CategoryProvider instance.
*/ */
public static CategoryProvider create(String title, public static CategoryProvider create(String title,
String description, String description,

27
ccm-atoz/src/com/arsdigita/atoz/ItemProvider.java
View File

@ -15,7 +15,6 @@
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/ */
package com.arsdigita.atoz; package com.arsdigita.atoz;
import com.arsdigita.domain.DomainCollection; import com.arsdigita.domain.DomainCollection;
@ -27,21 +26,18 @@ import com.arsdigita.util.Assert;
import com.arsdigita.categorization.Category; import com.arsdigita.categorization.Category;
/** /**
* *
* *
*/ */
public class ItemProvider extends AtoZProvider { public class ItemProvider extends AtoZProvider {
public static final String BASE_DATA_OBJECT_TYPE = public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.atoz.ItemProvider";
"com.arsdigita.atoz.ItemProvider";
public static final String CATEGORY = "category"; public static final String CATEGORY = "category";
public static final String LOAD_PATHS = "loadPaths"; public static final String LOAD_PATHS = "loadPaths";
public static final String ATOMIC_ENTRIES = public static final String ATOMIC_ENTRIES = "com.arsdigita.atoz.getAtomicItemEntries";
"com.arsdigita.atoz.getAtomicItemEntries";
/** /**
* Constructor * Constructor
@ -52,6 +48,8 @@ public class ItemProvider extends AtoZProvider {
/** /**
* Constructor * Constructor
*
* @param type
*/ */
protected ItemProvider(String type) { protected ItemProvider(String type) {
super(type); super(type);
@ -59,6 +57,8 @@ public class ItemProvider extends AtoZProvider {
/** /**
* Constructor * Constructor
*
* @param obj
*/ */
public ItemProvider(DataObject obj) { public ItemProvider(DataObject obj) {
super(obj); super(obj);
@ -66,6 +66,8 @@ public class ItemProvider extends AtoZProvider {
/** /**
* Constructor * Constructor
*
* @param oid
*/ */
public ItemProvider(OID oid) { public ItemProvider(OID oid) {
super(oid); super(oid);
@ -103,10 +105,6 @@ public class ItemProvider extends AtoZProvider {
} }
} }
/**
*
* @return
*/
public DomainCollection getAliases() { public DomainCollection getAliases() {
DomainCollection aliases = new DomainCollection(SessionManager.getSession() DomainCollection aliases = new DomainCollection(SessionManager.getSession()
.retrieve(ItemAlias.BASE_DATA_OBJECT_TYPE)); .retrieve(ItemAlias.BASE_DATA_OBJECT_TYPE));
@ -123,18 +121,11 @@ public class ItemProvider extends AtoZProvider {
set(LOAD_PATHS, loadPaths); set(LOAD_PATHS, loadPaths);
} }
/**
*
* @return
*/
public String getLoadPaths() { public String getLoadPaths() {
return (String) get(LOAD_PATHS); return (String) get(LOAD_PATHS);
} }
/** @Override
*
* @return
*/
public AtoZGenerator getGenerator() { public AtoZGenerator getGenerator() {
return new ItemGenerator(this); return new ItemGenerator(this);
} }

2
ccm-atoz/src/com/arsdigita/atoz/ui/admin/AdminPane.java
View File

@ -41,7 +41,7 @@ import java.util.Iterator;
/** /**
* *
* @depcreated UI integrated into Application tab at /ccm/admin. This class is now obsolete * @deprecated UI integrated into Application tab at /ccm/admin. This class is now obsolete
* and has been replaced by {@link AtoZAdminPane}. This class is kept here for now, but will be * and has been replaced by {@link AtoZAdminPane}. This class is kept here for now, but will be
* removed in a further release, together with the Admin UI at /ccm/atoz/admin. * removed in a further release, together with the Admin UI at /ccm/atoz/admin.
*/ */

4
ccm-cms-assets-imagestep/src/com/arsdigita/cms/contentassets/ui/ImageStepDisplay.java
View File

@ -51,9 +51,7 @@ import org.apache.log4j.Logger;
/** /**
* Component displays the currently attached images for an content item. It is * Component displays the currently attached images for an content item. It is
* part of the entry point image authoring step { * part of the entry point image authoring step {@see ImageStep}.
*
* @see ImageStep}.
* *
* It creates a list of images including meta information (name, type, width, * It creates a list of images including meta information (name, type, width,
* etc.), a link to remove from the list for each image and at the bottom a link * etc.), a link to remove from the list for each image and at the bottom a link

32
ccm-cms-types-mparticle/src/com/arsdigita/cms/contenttypes/MultiPartArticle.java
View File

@ -42,26 +42,19 @@ import java.util.List;
public class MultiPartArticle extends ContentPage { public class MultiPartArticle extends ContentPage {
private static final Logger s_log = Logger.getLogger(MultiPartArticle.class); private static final Logger s_log = Logger.getLogger(MultiPartArticle.class);
/** PDL property names */ /** PDL property names */
public static final String SUMMARY = "summary"; public static final String SUMMARY = "summary";
public static final String SECTIONS = "sections"; public static final String SECTIONS = "sections";
/** rank direction changes */ /** rank direction changes */
public static final int UP = 1; public static final int UP = 1;
public static final int DOWN = 2; public static final int DOWN = 2;
/** data object type for this domain object */ /** data object type for this domain object */
public static final String BASE_DATA_OBJECT_TYPE = public static final String BASE_DATA_OBJECT_TYPE =
"com.arsdigita.cms.contenttypes.MultiPartArticle"; "com.arsdigita.cms.contenttypes.MultiPartArticle";
/** named query parameters */ /** named query parameters */
public static final String RANK = "rank"; public static final String RANK = "rank";
public static final String ARTICLE = "article"; public static final String ARTICLE = "article";
public static final String SECTION = "section"; public static final String SECTION = "section";
private static MultiPartArticleConfig s_config = new MultiPartArticleConfig(); private static MultiPartArticleConfig s_config = new MultiPartArticleConfig();
static { static {
@ -85,8 +78,7 @@ public class MultiPartArticle extends ContentPage {
* @param id the id of the object to retrieve * @param id the id of the object to retrieve
*/ */
public MultiPartArticle(BigDecimal id) public MultiPartArticle(BigDecimal id)
throws DataObjectNotFoundException throws DataObjectNotFoundException {
{
this(new OID(BASE_DATA_OBJECT_TYPE, id)); this(new OID(BASE_DATA_OBJECT_TYPE, id));
} }
@ -96,8 +88,7 @@ public class MultiPartArticle extends ContentPage {
* @param id the object id of the object to retrieve * @param id the object id of the object to retrieve
*/ */
public MultiPartArticle(OID id) public MultiPartArticle(OID id)
throws DataObjectNotFoundException throws DataObjectNotFoundException {
{
super(id); super(id);
} }
@ -148,8 +139,7 @@ public class MultiPartArticle extends ContentPage {
* @param rank the rank of the ArticleSection in the association. * @param rank the rank of the ArticleSection in the association.
*/ */
public void addSection(ArticleSection section, Integer rank) { public void addSection(ArticleSection section, Integer rank) {
s_log.info("adding section:" + section.getName() + s_log.info("adding section:" + section.getName() + " with rank " + rank.toString());
" with rank " + rank.toString());
section.setRank(rank); section.setRank(rank);
add(SECTIONS, section); add(SECTIONS, section);
} }
@ -167,6 +157,7 @@ public class MultiPartArticle extends ContentPage {
/** /**
* Get the collection of sections. * Get the collection of sections.
* @return
*/ */
public ArticleSectionCollection getSections() { public ArticleSectionCollection getSections() {
return getSections(true); return getSections(true);
@ -185,11 +176,12 @@ public class MultiPartArticle extends ContentPage {
/** /**
* Change the rank of a given ArticleSection in this object. * Change the rank of a given ArticleSection in this object.
* @param sectionID
* @param rank
*/ */
public void changeSectionRank(BigDecimal sectionID, int rank) { public void changeSectionRank(BigDecimal sectionID, int rank) {
ArticleSection target = (ArticleSection) ArticleSection target = (ArticleSection) DomainObjectFactory.newInstance(new OID(
DomainObjectFactory.newInstance ArticleSection.BASE_DATA_OBJECT_TYPE, sectionID));
(new OID(ArticleSection.BASE_DATA_OBJECT_TYPE, sectionID));
changeSectionRank(target, rank); changeSectionRank(target, rank);
} }
@ -204,7 +196,6 @@ public class MultiPartArticle extends ContentPage {
changeSectionRank(section, rank); changeSectionRank(section, rank);
} }
protected int getRank(BigDecimal sectionID) { protected int getRank(BigDecimal sectionID) {
try { try {
ArticleSection section = new ArticleSection(sectionID); ArticleSection section = new ArticleSection(sectionID);
@ -214,7 +205,6 @@ public class MultiPartArticle extends ContentPage {
} }
} }
/** /**
* Change the rank of the sections with the given id within this object. * Change the rank of the sections with the given id within this object.
* Sets the section rank to that given, and moves all other section ranks * Sets the section rank to that given, and moves all other section ranks
@ -263,7 +253,6 @@ public class MultiPartArticle extends ContentPage {
coll.close(); coll.close();
} }
/** /**
* Returns the highest section rank. * Returns the highest section rank.
*/ */
@ -282,14 +271,14 @@ public class MultiPartArticle extends ContentPage {
} }
public static final int SUMMARY_LENGTH = 200; public static final int SUMMARY_LENGTH = 200;
public String getSearchSummary() { public String getSearchSummary() {
final String summary = getSummary(); final String summary = getSummary();
if (summary == null) { if (summary == null) {
return ""; return "";
} else { } else {
return com.arsdigita.util.StringUtils.truncateString return com.arsdigita.util.StringUtils.truncateString(summary, SUMMARY_LENGTH, true);
(summary, SUMMARY_LENGTH, true);
} }
} }
@ -298,6 +287,7 @@ public class MultiPartArticle extends ContentPage {
final List<ExtraXMLGenerator> generators = super.getExtraXMLGenerators(); final List<ExtraXMLGenerator> generators = super.getExtraXMLGenerators();
//generators.add(new ArticleSectionPanel()); //generators.add(new ArticleSectionPanel());
generators.add(new MultiPartArticleDataXMLGenerator());
generators.add(new ArticleSectionXMLGenerator()); generators.add(new ArticleSectionXMLGenerator());
return generators; return generators;

69
ccm-cms-types-mparticle/src/com/arsdigita/cms/contenttypes/ui/mparticle/SectionTable.java
View File

@ -18,7 +18,6 @@
*/ */
package com.arsdigita.cms.contenttypes.ui.mparticle; package com.arsdigita.cms.contenttypes.ui.mparticle;
import com.arsdigita.bebop.Component; import com.arsdigita.bebop.Component;
import com.arsdigita.bebop.ControlLink; import com.arsdigita.bebop.ControlLink;
import com.arsdigita.bebop.Label; import com.arsdigita.bebop.Label;
@ -47,7 +46,6 @@ import org.apache.log4j.Logger;
import java.math.BigDecimal; import java.math.BigDecimal;
/** /**
* A table that displays the sections for the currently * A table that displays the sections for the currently
* selected MultiPartArticle. * selected MultiPartArticle.
@ -55,16 +53,14 @@ import java.math.BigDecimal;
* @author <a href="mailto:dturner@arsdigita.com">Dave Turner</a> * @author <a href="mailto:dturner@arsdigita.com">Dave Turner</a>
* @version $Id: SectionTable.java 2099 2010-04-17 15:35:14Z pboy $ * @version $Id: SectionTable.java 2099 2010-04-17 15:35:14Z pboy $
*/ */
public class SectionTable extends Table public class SectionTable extends Table {
{
private static final Logger s_log = Logger.getLogger(SectionTable.class);
private static final Logger s_log = Logger.getLogger(SectionTable.class);
// match columns by (symbolic) index, makes for easier reordering // match columns by (symbolic) index, makes for easier reordering
public static final int COL_INDEX_TITLE = 0; // "Section"; public static final int COL_INDEX_TITLE = 0; // "Section";
public static final int COL_INDEX_EDIT = 1; // "Edit"; public static final int COL_INDEX_EDIT = 1; // "Edit";
public static final int COL_INDEX_MOVE = 2; // "Move"; public static final int COL_INDEX_MOVE = 2; // "Move";
public static final int COL_INDEX_DELETE = 3; // "Delete"; public static final int COL_INDEX_DELETE = 3; // "Delete";
private ItemSelectionModel m_selArticle; private ItemSelectionModel m_selArticle;
private ItemSelectionModel m_selSection; private ItemSelectionModel m_selSection;
private ItemSelectionModel m_moveSection; private ItemSelectionModel m_moveSection;
@ -87,23 +83,19 @@ public class SectionTable extends Table
model.add(new TableColumn( model.add(new TableColumn(
COL_INDEX_TITLE, COL_INDEX_TITLE,
new Label(MPArticleGlobalizationUtil.globalize( new Label(MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.header_section") "cms.contenttypes.ui.mparticle.section_table.header_section"))));
) ));
model.add(new TableColumn( model.add(new TableColumn(
COL_INDEX_EDIT, COL_INDEX_EDIT,
new Label(MPArticleGlobalizationUtil.globalize( new Label(MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.header_edit") "cms.contenttypes.ui.mparticle.section_table.header_edit"))));
) ));
model.add(new TableColumn( model.add(new TableColumn(
COL_INDEX_MOVE, COL_INDEX_MOVE,
new Label(MPArticleGlobalizationUtil.globalize( new Label(MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.header_move") "cms.contenttypes.ui.mparticle.section_table.header_move"))));
) ));
model.add(new TableColumn( model.add(new TableColumn(
COL_INDEX_DELETE, COL_INDEX_DELETE,
new Label(MPArticleGlobalizationUtil.globalize( new Label(MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.header_delete") "cms.contenttypes.ui.mparticle.section_table.header_delete"))));
) ));
model.get(1).setCellRenderer(new SectionTableCellRenderer(true)); model.get(1).setCellRenderer(new SectionTableCellRenderer(true));
model.get(2).setCellRenderer(new SectionTableCellRenderer(true)); model.get(2).setCellRenderer(new SectionTableCellRenderer(true));
@ -125,22 +117,17 @@ public class SectionTable extends Table
m_selSection m_selSection
.getSelectedKey(state)); .getSelectedKey(state));
} else { } else {
MultiPartArticle article = (MultiPartArticle) MultiPartArticle article = (MultiPartArticle) m_selArticle.
m_selArticle.getSelectedObject(state); getSelectedObject(state);
BigDecimal id = (BigDecimal) BigDecimal id = (BigDecimal) m_moveSection.getSelectedKey(state);
m_moveSection.getSelectedKey(state); ArticleSection sect = (ArticleSection) DomainObjectFactory.newInstance(
ArticleSection sect = (ArticleSection) new OID(ArticleSection.BASE_DATA_OBJECT_TYPE, id));
DomainObjectFactory.newInstance
(new OID
(ArticleSection.BASE_DATA_OBJECT_TYPE, id));
BigDecimal dest = BigDecimal dest =
new BigDecimal((String) event.getRowKey()); new BigDecimal((String) event.getRowKey());
ArticleSection destSect = (ArticleSection) ArticleSection destSect = (ArticleSection) DomainObjectFactory.newInstance(
DomainObjectFactory.newInstance new OID(ArticleSection.BASE_DATA_OBJECT_TYPE, dest));
(new OID
(ArticleSection.BASE_DATA_OBJECT_TYPE, dest));
// if sect is lower in rank than the dest // if sect is lower in rank than the dest
// then move below is default behavior // then move below is default behavior
@ -159,10 +146,10 @@ public class SectionTable extends Table
public void headSelected(TableActionEvent event) { public void headSelected(TableActionEvent event) {
// do nothing // do nothing
} }
}); });
} }
public void setSectionModel(ItemSelectionModel selSection) { public void setSectionModel(ItemSelectionModel selSection) {
if (selSection == null) { if (selSection == null) {
s_log.warn("null item model"); s_log.warn("null item model");
@ -170,7 +157,6 @@ public class SectionTable extends Table
m_selSection = selSection; m_selSection = selSection;
} }
/** /**
* The model builder to generate a suitable model for the SectionTable * The model builder to generate a suitable model for the SectionTable
*/ */
@ -180,7 +166,6 @@ public class SectionTable extends Table
protected ItemSelectionModel m_selArticle; protected ItemSelectionModel m_selArticle;
protected ItemSelectionModel m_moveSection; protected ItemSelectionModel m_moveSection;
/** /**
* Private class constructor. * Private class constructor.
* @param selArticle * @param selArticle
@ -192,7 +177,6 @@ public class SectionTable extends Table
m_moveSection = moveSection; m_moveSection = moveSection;
} }
/** /**
* *
* @param table * @param table
@ -210,7 +194,6 @@ public class SectionTable extends Table
} }
/** /**
* Internal class * Internal class
*/ */
@ -223,7 +206,6 @@ public class SectionTable extends Table
private ItemSelectionModel m_moveSection; private ItemSelectionModel m_moveSection;
private ArticleSection m_section; private ArticleSection m_section;
/** Constructor. /** Constructor.
* @param table * @param table
* @param state * @param state
@ -261,7 +243,9 @@ public class SectionTable extends Table
*/ */
public Object getElementAt(int columnIndex) { public Object getElementAt(int columnIndex) {
if ( m_colModel == null ) { return null; } if (m_colModel == null) {
return null;
}
// match columns by (symbolic) index, makes for easier reordering // match columns by (symbolic) index, makes for easier reordering
if (columnIndex == COL_INDEX_TITLE) { if (columnIndex == COL_INDEX_TITLE) {
@ -270,27 +254,23 @@ public class SectionTable extends Table
//return "edit"; //return "edit";
return new Label( return new Label(
MPArticleGlobalizationUtil.globalize( MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.link_edit") "cms.contenttypes.ui.mparticle.section_table.link_edit"));
);
} else if (columnIndex == COL_INDEX_DELETE) { } else if (columnIndex == COL_INDEX_DELETE) {
// return "delete"; // return "delete";
return new Label( return new Label(
MPArticleGlobalizationUtil.globalize( MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.link_delete") "cms.contenttypes.ui.mparticle.section_table.link_delete"));
);
} else if (columnIndex == COL_INDEX_MOVE) { } else if (columnIndex == COL_INDEX_MOVE) {
if (m_moveSection.getSelectedKey(m_state) == null) { if (m_moveSection.getSelectedKey(m_state) == null) {
// return "move"; // return "move";
return new Label( return new Label(
MPArticleGlobalizationUtil.globalize( MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.link_move") "cms.contenttypes.ui.mparticle.section_table.link_move"));
);
} else { } else {
// return "move below here"; // return "move below here";
return new Label( return new Label(
MPArticleGlobalizationUtil.globalize( MPArticleGlobalizationUtil.globalize(
"cms.contenttypes.ui.mparticle.section_table.link_move_below") "cms.contenttypes.ui.mparticle.section_table.link_move_below"));
);
} }
} }
@ -306,7 +286,6 @@ public class SectionTable extends Table
} }
/** /**
* *
*/ */
@ -319,8 +298,7 @@ public class SectionTable extends Table
this(false); this(false);
} }
public SectionTableCellRenderer public SectionTableCellRenderer(boolean active) {
( boolean active ) {
m_active = active; m_active = active;
} }
@ -359,8 +337,5 @@ public class SectionTable extends Table
return ret; return ret;
} }
} }
} }

2
ccm-cms/src/com/arsdigita/cms/CMSConfig.java
View File

@ -781,7 +781,7 @@ public final class CMSConfig extends AbstractConfig {
} }
/** /**
* Retrieve path of the root folter for template folders. Path is * Retrieve path of the root folder for template folders. Path is
* relative to webapp root. * relative to webapp root.
*/ */
public final String getTemplateRoot() { public final String getTemplateRoot() {

59
ccm-core/src/com/arsdigita/auditing/AuditedACSObject.java
View File

@ -27,130 +27,129 @@ import com.arsdigita.persistence.OID;
import com.arsdigita.persistence.DataObject; import com.arsdigita.persistence.DataObject;
import com.arsdigita.persistence.metadata.ObjectType; import com.arsdigita.persistence.metadata.ObjectType;
import java.util.Date; import java.util.Date;
/** /**
* Base class. Provides default functionality for auditing ACSObjects. * Base class. Provides default functionality for auditing ACSObjects.
* *
* <p>
*
* </p>
*
* @author Joseph Bank * @author Joseph Bank
* @version 1.0 * @version 1.0
* @version $Id: AuditedACSObject.java 2089 2010-04-17 07:55:43Z pboy $ * @version $Id: AuditedACSObject.java 2089 2010-04-17 07:55:43Z pboy $
*/ */
public abstract class AuditedACSObject extends ACSObject implements Audited { public abstract class AuditedACSObject extends ACSObject implements Audited {
/** /**
* Audit trail. * Audit trail.
*/ */
private BasicAuditTrail m_audit_trail; private BasicAuditTrail m_audit_trail;
/** /**
* Gets the user who created the object. May be null. * Gets the user who created the object. May be null.
*
* @return the user who created the object. * @return the user who created the object.
*/ */
@Override
public User getCreationUser() { public User getCreationUser() {
return m_audit_trail.getCreationUser(); return m_audit_trail.getCreationUser();
} }
/** /**
* Gets the creation date of the object. * Gets the creation date of the object.
*
* @return the creation date. * @return the creation date.
*/ */
@Override
public Date getCreationDate() { public Date getCreationDate() {
return m_audit_trail.getCreationDate(); return m_audit_trail.getCreationDate();
} }
/** /**
* Gets the IP address associated with creating an object. May be * Gets the IP address associated with creating an object. May be null.
* null. *
* @return the creation IP address. * @return the creation IP address.
*/ */
@Override
public String getCreationIP() { public String getCreationIP() {
return m_audit_trail.getCreationIP(); return m_audit_trail.getCreationIP();
} }
/** /**
* Gets the user who last modified the object. May be null. * Gets the user who last modified the object. May be null.
*
* @return the last modifying user. * @return the last modifying user.
*/ */
@Override
public User getLastModifiedUser() { public User getLastModifiedUser() {
return m_audit_trail.getLastModifiedUser(); return m_audit_trail.getLastModifiedUser();
} }
/** /**
* Gets the last modified date. * Gets the last modified date.
*
* @return the last modified date. * @return the last modified date.
*/ */
@Override
public Date getLastModifiedDate() { public Date getLastModifiedDate() {
return m_audit_trail.getLastModifiedDate(); return m_audit_trail.getLastModifiedDate();
} }
/** /**
* Gets the last modified IP address. May be null. * Gets the last modified IP address. May be null.
*
* @return the IP address associated with the last modification. * @return the IP address associated with the last modification.
*/ */
@Override
public String getLastModifiedIP() { public String getLastModifiedIP() {
return m_audit_trail.getLastModifiedIP(); return m_audit_trail.getLastModifiedIP();
} }
/** /**
* Initializes with a basic audit trail and an Auditing Observer. * Initialises with a basic audit trail and an Auditing Observer. This method is called from the
* This method is called from the DomainObject constructor, so it * DomainObject constructor, so it is invoked whenever a new ACSObject is constructed.
* is invoked whenever a new ACSObject is constructed.
*
* @post m_audit_trail != null
*/ */
@Override
protected void initialize() { protected void initialize() {
super.initialize(); super.initialize();
//Get the audit trail for this object //Get the audit trail for this object
m_audit_trail = BasicAuditTrail.retrieveForACSObject(this); m_audit_trail = BasicAuditTrail.retrieveForACSObject(this);
addObserver(new AuditingObserver(m_audit_trail)); addObserver(new AuditingObserver(m_audit_trail));
} }
/** /**
* Equaivalent to the corresponding ACSObject constructor. * Equivalent to the corresponding ACSObject constructor.
*
* @param AuditedACSObjectData
*/ */
protected AuditedACSObject(DataObject AuditedACSObjectData) { protected AuditedACSObject(DataObject AuditedACSObjectData) {
super(AuditedACSObjectData); super(AuditedACSObjectData);
} }
/** /**
* Equaivalent to the corresponding ACSObject constructor. * Equivalent to the corresponding ACSObject constructor.
*
* @param typeName
*/ */
public AuditedACSObject(String typeName) { public AuditedACSObject(String typeName) {
super(typeName); super(typeName);
} }
/** /**
* Equaivalent to the corresponding ACSObject constructor. * Equivalent to the corresponding ACSObject constructor.
*
* @param type
*/ */
public AuditedACSObject(ObjectType type) { public AuditedACSObject(ObjectType type) {
super(type); super(type);
} }
/** /**
* Equaivalent to the corresponding ACSObject constructor. * Equivalent to the corresponding ACSObject constructor.
*
* @param oid
*/ */
public AuditedACSObject(OID oid) throws DataObjectNotFoundException { public AuditedACSObject(OID oid) throws DataObjectNotFoundException {
super(oid); super(oid);
} }
} }

2
ccm-core/src/com/arsdigita/auditing/AuditingSaveFactory.java
View File

@ -44,7 +44,7 @@ public class AuditingSaveFactory {
/** /**
* Sets the prototype object for the factory. * Sets the prototype object for the factory.
* *
* @param a prototype AuditingSaveInfo object * @param proto a prototype AuditingSaveInfo object
*/ */
public static void setPrototype(AuditingSaveInfo proto) { public static void setPrototype(AuditingSaveInfo proto) {
s_proto.set(proto); s_proto.set(proto);

6
ccm-core/src/com/arsdigita/loader/PackageLoader.java
View File

@ -117,12 +117,6 @@ public abstract class PackageLoader extends AbstractScript {
s_log.info("Loading: Done"); s_log.info("Loading: Done");
} }
/**
*
*
* @param args
* @return
*/
public static ParameterReader reader(String[] args) { public static ParameterReader reader(String[] args) {
CompoundParameterReader result = new CompoundParameterReader(); CompoundParameterReader result = new CompoundParameterReader();
result.add(new JavaPropertyReader(props(args))); result.add(new JavaPropertyReader(props(args)));

4
ccm-core/src/com/arsdigita/ui/admin/AdminServlet.java
View File

@ -45,9 +45,9 @@ import javax.servlet.http.HttpServletResponse;
* Web Developer Support Application Servlet class, central entry point to create and process the applications UI. * Web Developer Support Application Servlet class, central entry point to create and process the applications UI.
* *
* We should have subclassed BebopApplicationServlet but couldn't overwrite doService() method to add permission * We should have subclassed BebopApplicationServlet but couldn't overwrite doService() method to add permission
* checking. So we use our own page mapping. The general logic is the same as for BebopApplicationServlet. { * checking. So we use our own page mapping. The general logic is the same as for BebopApplicationServlet.
* *
* @see com.arsdigita.bebop.page.BebopApplicationServlet} * {@see com.arsdigita.bebop.page.BebopApplicationServlet}
* *
* @author Jens Pelzetter * @author Jens Pelzetter
* @author pb * @author pb

42
ccm-core/src/com/arsdigita/web/Application.java
View File

@ -141,7 +141,7 @@ public class Application extends Resource {
* @param fragment URL fragment of the application * @param fragment URL fragment of the application
* @param title * @param title
* @param parent parent Application * @param parent parent Application
* @return * @return The new Application
*/ */
public static Application createApplication(final ApplicationType type, public static Application createApplication(final ApplicationType type,
final String fragment, final String fragment,
@ -158,7 +158,7 @@ public class Application extends Resource {
* @param fragment URL fragment of the application * @param fragment URL fragment of the application
* @param title * @param title
* @param parent * @param parent
* @return * @return The new application
*/ */
public static Application createApplication(final String typeName, public static Application createApplication(final String typeName,
final String fragment, final String fragment,
@ -175,7 +175,7 @@ public class Application extends Resource {
* @param title * @param title
* @param parent * @param parent
* @param createContainerGroup * @param createContainerGroup
* @return * @return The new application
*/ */
public static Application createApplication( public static Application createApplication(
final String typeName, final String typeName,
@ -205,7 +205,7 @@ public class Application extends Resource {
* @param title * @param title
* @param parent parent application * @param parent parent application
* @param createContainerGroup * @param createContainerGroup
* @return * @return The new application
*/ */
public static Application createApplication( public static Application createApplication(
final ApplicationType type, final ApplicationType type,
@ -233,7 +233,7 @@ public class Application extends Resource {
* @param title descriptive name * @param title descriptive name
* @param parent * @param parent
* @param createContainerGroup * @param createContainerGroup
* @return * @return The new application
*/ */
private static Application make(final ApplicationType type, private static Application make(final ApplicationType type,
final String fragment, final String fragment,
@ -283,8 +283,8 @@ public class Application extends Resource {
/** /**
* *
* @param id * @param id The id of the application instance.
* @return * @return The application instance identified by {@code id}.
*/ */
public static Application retrieveApplication(BigDecimal id) { public static Application retrieveApplication(BigDecimal id) {
OID oid = new OID(BASE_DATA_OBJECT_TYPE, id); OID oid = new OID(BASE_DATA_OBJECT_TYPE, id);
@ -294,8 +294,8 @@ public class Application extends Resource {
/** /**
* *
* @param oid * @param oid The {@link OID} of the application to retrieve.
* @return * @return The application instance identified by {@code oid}
*/ */
public static Application retrieveApplication(OID oid) { public static Application retrieveApplication(OID oid) {
DataObject dataObject = SessionManager.getSession().retrieve(oid); DataObject dataObject = SessionManager.getSession().retrieve(oid);
@ -309,8 +309,8 @@ public class Application extends Resource {
/** /**
* *
* @param dobj * @param dobj A {@link DataObject} representing a application instance.
* @return * @return A DomainObject representing the application instance.
*/ */
public static Application retrieveApplication(DataObject dobj) { public static Application retrieveApplication(DataObject dobj) {
Assert.exists(dobj, DataObject.class); Assert.exists(dobj, DataObject.class);
@ -324,11 +324,6 @@ public class Application extends Resource {
} }
} }
/**
*
* @param obj
* @return
*/
public static Application getContainingApplication(ACSObject obj) { public static Application getContainingApplication(ACSObject obj) {
Assert.exists(obj, ACSObject.class); Assert.exists(obj, ACSObject.class);
ACSObject result = obj.gimmeContainer(); ACSObject result = obj.gimmeContainer();
@ -342,8 +337,9 @@ public class Application extends Resource {
/** /**
* *
* @param path * @param path Path of the application to retrieve
* @return (Can return null.) * @return The application mounted at {@code path} or {@code null} if there is not such
* application.
*/ */
public static Application retrieveApplicationForPath(String path) { public static Application retrieveApplicationForPath(String path) {
@ -397,7 +393,7 @@ public class Application extends Resource {
/** /**
* . * .
* Ordered from most distant to closest ancestor. * Ordered from most distant to closest ancestor.
* @return * @return List of the ancestor applications.
*/ */
public List getAncestorApplications() { public List getAncestorApplications() {
// This is the stupid implementation. // This is the stupid implementation.
@ -436,7 +432,7 @@ public class Application extends Resource {
/** /**
* *
* @param applicationType * @param applicationType
* @return * @return Collection of the child applications
*/ */
public ApplicationCollection getChildApplicationsForType(String applicationType) { public ApplicationCollection getChildApplicationsForType(String applicationType) {
ApplicationCollection children = getChildApplications(); ApplicationCollection children = getChildApplications();
@ -583,7 +579,7 @@ public class Application extends Resource {
* *
* @param applicationObjectType * @param applicationObjectType
* @param path * @param path
* @return * @return {@code true} if the application type is installed, {@code false} otherwise.
*/ */
public static boolean isInstalled(String applicationObjectType, public static boolean isInstalled(String applicationObjectType,
String path) { String path) {
@ -619,10 +615,6 @@ public class Application extends Resource {
return canonicalURL; return canonicalURL;
} }
/**
*
* @return
*/
public String getContextPath() { public String getContextPath() {
return ""; return "";
} }

2
ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/personal/PersonalPortalPage.java
View File

@ -38,7 +38,7 @@ import org.apache.log4j.Logger;
/** /**
* *
* @author * @author unknown
*/ */
public class PersonalPortalPage extends Page { public class PersonalPortalPage extends Page {

2
ccm-portalworkspace/src/com/arsdigita/portalworkspace/ui/portlet/RSSFeedPortletEditorForm.java
View File

@ -32,7 +32,7 @@ import com.arsdigita.portal.Portlet;
/** /**
* *
* @author * @author unknown
*/ */
public class RSSFeedPortletEditorForm extends PortletConfigFormSection { public class RSSFeedPortletEditorForm extends PortletConfigFormSection {

2
ccm-sci-publications/src/com/arsdigita/cms/contenttypes/ui/SeriesExtraXmlGenerator.java
View File

@ -211,8 +211,6 @@ public class SeriesExtraXmlGenerator implements ExtraXMLGenerator {
}); });
} }
final Element volumesElem = parent.newChildElement("volumes"); final Element volumesElem = parent.newChildElement("volumes");
for (VolumeEntry entry : volumeList) { for (VolumeEntry entry : volumeList) {
createVolumeXml(entry.getPublication(), entry.getVolumeOfSeries(), volumesElem, state); createVolumeXml(entry.getPublication(), entry.getVolumeOfSeries(), volumesElem, state);