Java > Open Source Codes > org > opencms > workplace > tools > searchindex > CmsDocumentTypeAddList


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/searchindex/CmsDocumentTypeAddList.java,v $
3  * Date : $Date: 2006/03/27 14:52:21 $
4  * Version: $Revision: 1.2 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.tools.searchindex;
33
34 import org.opencms.configuration.CmsSearchConfiguration;
35 import org.opencms.i18n.CmsMessageContainer;
36 import org.opencms.jsp.CmsJspActionElement;
37 import org.opencms.main.CmsLog;
38 import org.opencms.main.OpenCms;
39 import org.opencms.search.CmsSearchDocumentType;
40 import org.opencms.search.CmsSearchIndexSource;
41 import org.opencms.search.CmsSearchManager;
42 import org.opencms.workplace.CmsWorkplaceSettings;
43 import org.opencms.workplace.list.CmsListColumnAlignEnum;
44 import org.opencms.workplace.list.CmsListColumnDefinition;
45 import org.opencms.workplace.list.CmsListDefaultAction;
46 import org.opencms.workplace.list.CmsListDirectAction;
47 import org.opencms.workplace.list.CmsListItem;
48 import org.opencms.workplace.list.CmsListItemDetails;
49 import org.opencms.workplace.list.CmsListItemDetailsFormatter;
50 import org.opencms.workplace.list.CmsListMetadata;
51 import org.opencms.workplace.list.CmsListMultiAction;
52 import org.opencms.workplace.list.CmsListOrderEnum;
53
54 import java.util.ArrayList ;
55 import java.util.Iterator ;
56 import java.util.LinkedList ;
57 import java.util.List ;
58
59 import javax.servlet.http.HttpServletRequest ;
60 import javax.servlet.http.HttpServletResponse ;
61 import javax.servlet.jsp.PageContext ;
62
63 import org.apache.commons.logging.Log;
64
65 /**
66  * A list that displays the document types of the system that are not assigned to
67  * a request parameter given
68  * <code>{@link org.opencms.search.CmsSearchIndexSource}</code> ("indexsource") and
69  * offers add single- and multi-actions that add those document types to the current
70  * indexsource.<p>
71  *
72  * This list is no stand-alone page but has to be embedded in another dialog
73  * (see <code> {@link org.opencms.workplace.tools.searchindex.A_CmsEmbeddedListDialog}</code>. <p>
74  *
75  * @author Achim Westermann
76  *
77  * @version $Revision: 1.2 $
78  *
79  * @since 6.0.0
80  */
81 public class CmsDocumentTypeAddList extends A_CmsEmbeddedListDialog {
82
83     /** list action id constant. */
84     public static final String LIST_ACTION_ADD_DOCTYPE = "aad";
85
86     /** list action id constant. */
87     public static final String LIST_ACTION_ADD_DOCTYPE2 = LIST_ACTION_ADD_DOCTYPE + "2";
88
89     /** list action dummy id constant. */
90     public static final String LIST_ACTION_NONE = "an";
91
92     /** list column id constant. */
93     public static final String LIST_COLUMN_ADD_DOCTYPE = "cad";
94
95     /** list column id constant. */
96     public static final String LIST_COLUMN_DOCCLASS = "cdc";
97
98     /** list column id constant. */
99     public static final String LIST_COLUMN_ICON = "ci";
100
101     /** list column id constant. */
102     public static final String LIST_COLUMN_NAME = "cn";
103
104     /** list item detail id constant. */
105     public static final String LIST_DETAIL_MIMETYPES = "dmt";
106
107     /** list item detail id constant. */
108     public static final String LIST_DETAIL_RESOURCETYPES = "drt";
109
110     /** list id constant. */
111     public static final String LIST_ID = "lssisdta";
112
113     /** list action id constant. */
114     public static final String LIST_MACTION_ADD_DOCTYPE = "maad";
115
116     /** The log object for this class. */
117     private static final Log LOG = CmsLog.getLog(CmsDocumentTypeAddList.class);
118
119     /** Stores the value of the request parameter for the search index source name. */
120     private String m_paramIndexsource;
121
122     /**
123      * Public constructor.<p>
124      *
125      * @param jsp an initialized JSP action element
126      */
127     public CmsDocumentTypeAddList(CmsJspActionElement jsp) {
128
129         this(jsp, LIST_ID, Messages.get().container(Messages.GUI_LIST_DOCUMENTTYPES_AVAIL_NAME_0));
130     }
131
132     /**
133      * Public constructor.<p>
134      *
135      * @param jsp an initialized JSP action element
136      * @param listId the id of the list
137      * @param listName the list name
138      */
139     public CmsDocumentTypeAddList(CmsJspActionElement jsp, String listId, CmsMessageContainer listName) {
140
141         this(jsp, listId, listName, LIST_COLUMN_NAME, CmsListOrderEnum.ORDER_ASCENDING, null);
142     }
143
144     /**
145      * Public constructor.<p>
146      *
147      * @param jsp an initialized JSP action element
148      * @param listId the id of the displayed list
149      * @param listName the name of the list
150      * @param sortedColId the a priory sorted column
151      * @param sortOrder the order of the sorted column
152      * @param searchableColId the column to search into
153      */
154     public CmsDocumentTypeAddList(
155         CmsJspActionElement jsp,
156         String listId,
157         CmsMessageContainer listName,
158         String sortedColId,
159         CmsListOrderEnum sortOrder,
160         String searchableColId) {
161
162         super(jsp, listId, listName, sortedColId, sortOrder, searchableColId);
163
164     }
165
166     /**
167      * Public constructor.<p>
168      *
169      * Public constructor with JSP variables.<p>
170      *
171      * @param context the JSP page context
172      * @param req the JSP request
173      * @param res the JSP response
174      */
175     public CmsDocumentTypeAddList(PageContext context, HttpServletRequest req, HttpServletResponse res) {
176
177         this(new CmsJspActionElement(context, req, res));
178     }
179
180     /**
181      * @see org.opencms.workplace.list.A_CmsListDialog#executeListMultiActions()
182      */
183     public void executeListMultiActions() {
184
185         CmsSearchManager searchManager = OpenCms.getSearchManager();
186         if (getParamListAction().equals(LIST_MACTION_ADD_DOCTYPE)) {
187             // execute the delete multiaction
188 Iterator itItems = getSelectedItems().iterator();
189             CmsListItem listItem;
190             String doctype;
191             CmsSearchIndexSource idxsrc = searchManager.getIndexSource(getParamIndexsource());
192             while (itItems.hasNext()) {
193                 listItem = (CmsListItem)itItems.next();
194                 doctype = (String )listItem.get(LIST_COLUMN_NAME);
195                 idxsrc.addDocumentType(doctype);
196                 getList().removeItem(listItem.getId(), getLocale());
197             }
198             writeConfiguration(false);
199             refreshList();
200         }
201         listSave();
202     }
203
204     /**
205      * @see org.opencms.workplace.list.A_CmsListDialog#executeListSingleActions()
206      */
207     public void executeListSingleActions() {
208
209         CmsSearchManager searchManager = OpenCms.getSearchManager();
210         String action = getParamListAction();
211         if (action.equals(LIST_ACTION_ADD_DOCTYPE) || action.equals(LIST_ACTION_ADD_DOCTYPE2)) {
212             CmsSearchIndexSource idxsrc = searchManager.getIndexSource(getParamIndexsource());
213             CmsListItem item = getSelectedItem();
214             String doctypeName = (String )item.get(LIST_COLUMN_NAME);
215             idxsrc.addDocumentType(doctypeName);
216             getList().removeItem(item.getId(), getLocale());
217             refreshList();
218             writeConfiguration(false);
219         }
220     }
221
222     /**
223      * Returns the request parameter "indexsource".<p>
224      *
225      * @return the request parameter "indexsource"
226      */
227     public String getParamIndexsource() {
228
229         return m_paramIndexsource;
230     }
231
232     /**
233      * Sets the request parameter "indexsource". <p>
234      *
235      * Method intended for workplace-properietary automatic filling of
236      * request parameter values to dialogs, not for manual invocation. <p>
237      *
238      * @param indexsource the request parameter "indexsource" to set
239      */
240     public void setParamIndexsource(String indexsource) {
241
242         m_paramIndexsource = indexsource;
243     }
244
245     /**
246      * @see org.opencms.workplace.list.A_CmsListDialog#fillDetails(java.lang.String)
247      */
248     protected void fillDetails(String detailId) {
249
250         // get content
251 List items = getList().getAllContent();
252         Iterator itItems = items.iterator();
253         CmsListItem item;
254         if (detailId.equals(LIST_DETAIL_MIMETYPES)) {
255             while (itItems.hasNext()) {
256                 item = (CmsListItem)itItems.next();
257                 fillDetailMimetypes(item, detailId);
258
259             }
260         }
261         if (detailId.equals(LIST_DETAIL_RESOURCETYPES)) {
262             while (itItems.hasNext()) {
263                 item = (CmsListItem)itItems.next();
264                 fillDetailResourceTypes(item, detailId);
265
266             }
267
268         }
269
270     }
271
272     /**
273      * @see org.opencms.workplace.list.A_CmsListDialog#getListItems()
274      */
275     protected List getListItems() {
276
277         List result = new ArrayList ();
278         // get content
279 List doctypes = documentTypes();
280         Iterator itDoctypes = doctypes.iterator();
281         CmsSearchDocumentType doctype;
282         while (itDoctypes.hasNext()) {
283             doctype = (CmsSearchDocumentType)itDoctypes.next();
284             CmsListItem item = getList().newItem(doctype.getName());
285             item.set(LIST_COLUMN_NAME, doctype.getName());
286             item.set(LIST_COLUMN_DOCCLASS, doctype.getClassName());
287             result.add(item);
288         }
289         return result;
290     }
291
292     /**
293      * @see org.opencms.workplace.CmsWorkplace#initMessages()
294      */
295     protected void initMessages() {
296
297         // add specific dialog resource bundle
298 addMessages(Messages.get().getBundleName());
299         // add default resource bundles
300 super.initMessages();
301     }
302
303     /**
304      * @see org.opencms.workplace.list.A_CmsListDialog#initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
305      */
306     protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) {
307
308         super.initWorkplaceRequestValues(settings, request);
309     }
310
311     /**
312      * @see org.opencms.workplace.list.A_CmsListDialog#setColumns(org.opencms.workplace.list.CmsListMetadata)
313      */
314     protected void setColumns(CmsListMetadata metadata) {
315
316         // create dummy column for corporate design reasons
317 CmsListColumnDefinition dummyCol = new CmsListColumnDefinition(LIST_COLUMN_ICON);
318         dummyCol.setName(Messages.get().container(Messages.GUI_LIST_DOCUMENTTYPE_NAME_0));
319         dummyCol.setHelpText(Messages.get().container(Messages.GUI_LIST_DOCUMENTTYPE_NAME_HELP_0));
320         dummyCol.setWidth("20");
321         dummyCol.setAlign(CmsListColumnAlignEnum.ALIGN_LEFT);
322         dummyCol.setSorteable(false);
323         // add dummy icon
324 CmsListDirectAction dummyAction = new CmsListDirectAction(LIST_ACTION_NONE);
325         dummyAction.setName(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ICON_NAME_0));
326         dummyAction.setHelpText(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ICON_NAME_HELP_0));
327         dummyAction.setIconPath(CmsDocumentTypeList.ICON_DOCTYPE);
328         // disable!
329 dummyAction.setEnabled(false);
330         dummyCol.addDirectAction(dummyAction);
331         // add it to the list definition
332 metadata.addColumn(dummyCol);
333
334         // add column for add single-action
335 CmsListColumnDefinition addCol = new CmsListColumnDefinition(LIST_COLUMN_ADD_DOCTYPE);
336         addCol.setName(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ADD_DOCTYPE_NAME_0));
337         addCol.setHelpText(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ADD_DOCTYPE_NAME_HELP_0));
338         addCol.setWidth("20");
339         addCol.setAlign(CmsListColumnAlignEnum.ALIGN_LEFT);
340         addCol.setSorteable(false);
341         // add add action
342 CmsListDirectAction addAction = new CmsListDirectAction(LIST_ACTION_ADD_DOCTYPE);
343         addAction.setName(Messages.get().container(Messages.GUI_LIST_SEARCHINDEX_ACTION_ADD_DOCTYPE_NAME_0));
344         addAction.setHelpText(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ADD_DOCTYPE_NAME_HELP_0));
345         addAction.setIconPath(ICON_ADD);
346         addCol.addDirectAction(addAction);
347         metadata.addColumn(addCol);
348
349         // add column for name
350 CmsListColumnDefinition nameCol = new CmsListColumnDefinition(LIST_COLUMN_NAME);
351         nameCol.setAlign(CmsListColumnAlignEnum.ALIGN_LEFT);
352         nameCol.setName(Messages.get().container(Messages.GUI_LIST_SEARCHINDEX_COL_NAME_0));
353         nameCol.setWidth("50%");
354         metadata.addColumn(nameCol);
355         // add duplicate remove action
356 CmsListDefaultAction remAction2 = new CmsListDefaultAction(LIST_ACTION_ADD_DOCTYPE2);
357         remAction2.setName(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ADD_DOCTYPE_NAME_0));
358         remAction2.setHelpText(Messages.get().container(Messages.GUI_LIST_INDEXSOURCE_COL_ADD_DOCTYPE_NAME_HELP_0));
359         nameCol.addDefaultAction(remAction2);
360         metadata.addColumn(nameCol);
361
362         // add column for document implementation class
363 CmsListColumnDefinition docclassCol = new CmsListColumnDefinition(LIST_COLUMN_DOCCLASS);
364         docclassCol.setAlign(CmsListColumnAlignEnum.ALIGN_LEFT);
365         docclassCol.setName(Messages.get().container(Messages.GUI_LIST_DOCTYPE_COL_DOCCLASS_0));
366         docclassCol.setWidth("45%");
367         metadata.addColumn(docclassCol);
368
369     }
370
371     /**
372      * @see org.opencms.workplace.list.A_CmsListDialog#setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
373      */
374     protected void setIndependentActions(CmsListMetadata metadata) {
375
376         // add document types of index source detail help
377 CmsListItemDetails mimetypeDetails = new CmsListItemDetails(LIST_DETAIL_MIMETYPES);
378         mimetypeDetails.setAtColumn(LIST_COLUMN_NAME);
379         mimetypeDetails.setVisible(false);
380         mimetypeDetails.setShowActionName(Messages.get().container(Messages.GUI_LIST_DOCTYPE_DETAIL_MIMETYPES_SHOW_0));
381         mimetypeDetails.setShowActionHelpText(Messages.get().container(
382             Messages.GUI_LIST_DOCTYPE_DETAIL_MIMETYPES_SHOW_HELP_0));
383         mimetypeDetails.setHideActionName(Messages.get().container(Messages.GUI_LIST_DOCTYPE_DETAIL_MIMETYPES_HIDE_0));
384         mimetypeDetails.setHideActionHelpText(Messages.get().container(
385             Messages.GUI_LIST_DOCTYPE_DETAIL_MIMETYPES_HIDE_HELP_0));
386         mimetypeDetails.setName(Messages.get().container(Messages.GUI_LIST_DOCTYPE_DETAIL_MIMETYPES_NAME_0));
387         mimetypeDetails.setFormatter(new CmsListItemDetailsFormatter(Messages.get().container(
388             Messages.GUI_LIST_DOCTYPE_DETAIL_MIMETYPES_NAME_0)));
389         metadata.addItemDetails(mimetypeDetails);
390
391         // add resources of index source detail help
392 CmsListItemDetails resourceDetails = new CmsListItemDetails(LIST_DETAIL_RESOURCETYPES);
393         resourceDetails.setAtColumn(LIST_COLUMN_NAME);
394         resourceDetails.setVisible(false);
395         resourceDetails.setShowActionName(Messages.get().container(
396             Messages.GUI_LIST_DOCTYPE_DETAIL_RESOURCETYPES_SHOW_0));
397         resourceDetails.setShowActionHelpText(Messages.get().container(
398             Messages.GUI_LIST_DOCTYPE_DETAIL_RESOURCETYPES_SHOW_HELP_0));
399         resourceDetails.setHideActionName(Messages.get().container(
400             Messages.GUI_LIST_DOCTYPE_DETAIL_RESOURCETYPES_HIDE_0));
401         resourceDetails.setHideActionHelpText(Messages.get().container(
402             Messages.GUI_LIST_DOCTYPE_DETAIL_RESOURCETYPES_HIDE_HELP_0));
403         resourceDetails.setName(Messages.get().container(Messages.GUI_LIST_DOCTYPE_DETAIL_RESOURCETYPES_NAME_0));
404         resourceDetails.setFormatter(new CmsListItemDetailsFormatter(Messages.get().container(
405             Messages.GUI_LIST_DOCTYPE_DETAIL_RESOURCETYPES_NAME_0)));
406         metadata.addItemDetails(resourceDetails);
407
408     }
409
410     /**
411      * @see org.opencms.workplace.list.A_CmsListDialog#setMultiActions(org.opencms.workplace.list.CmsListMetadata)
412      */
413     protected void setMultiActions(CmsListMetadata metadata) {
414
415         // add add multi action
416 CmsListMultiAction addMultiAction = new CmsListMultiAction(LIST_MACTION_ADD_DOCTYPE);
417         addMultiAction.setName(Messages.get().container(Messages.GUI_LIST_SEARCHINDEX_MACTION_ADD_DOCTYPE_NAME_0));
418         addMultiAction.setHelpText(Messages.get().container(
419             Messages.GUI_LIST_SEARCHINDEX_MACTION_ADD_DOCTYPE_NAME_HELP_0));
420         addMultiAction.setIconPath(ICON_MULTI_ADD);
421         metadata.addMultiAction(addMultiAction);
422     }
423
424     /**
425      * Writes the updated search configuration back to the XML
426      * configuration file and refreshes the complete list.<p>
427      *
428      * @param refresh if true, the list items are refreshed
429      */
430     protected void writeConfiguration(boolean refresh) {
431
432         // update the XML configuration
433 OpenCms.writeConfiguration(CmsSearchConfiguration.class);
434         if (refresh) {
435             refreshList();
436         }
437     }
438
439     /**
440      * Returns the systems configured document types that are not assigned
441      * to the current indexsource (those that may be added).<p>
442      *
443      * @return the systems configured document types that are not assigned
444      * to the current indexsource (those that may be added)
445      */
446     private List documentTypes() {
447
448         CmsSearchManager manager = OpenCms.getSearchManager();
449         CmsSearchIndexSource indexsource = manager.getIndexSource(getParamIndexsource());
450         List result;
451         if (indexsource != null) {
452             // indexsource returns only unmodifyable set
453 List systemDoctypeNames = new LinkedList (manager.getDocumentTypeConfigs().keySet());
454             List doctypeNames = new LinkedList (indexsource.getDocumentTypes());
455             // accept only the complement of system doctypes to the indexsources doctypes:
456 systemDoctypeNames.removeAll(doctypeNames);
457
458             // transform these mere names to real document types...
459 result = new ArrayList (systemDoctypeNames.size());
460             Iterator it = systemDoctypeNames.iterator();
461             String doctypename = "";
462             CmsSearchDocumentType doctype;
463             while (it.hasNext()) {
464                 doctypename = (String )it.next();
465                 if (doctypename != null) {
466                     doctype = manager.getDocumentTypeConfig(doctypename);
467                     if (doctype != null) {
468                         result.add(doctype);
469                     }
470                 }
471             }
472         } else {
473             result = new ArrayList (0);
474             if (LOG.isErrorEnabled()) {
475                 LOG.error(Messages.get().getBundle().key(Messages.ERR_SEARCHINDEX_EDIT_MISSING_PARAM_1, "indexsource"));
476             }
477         }
478         return result;
479     }
480
481     /**
482      * Fills details about configured mime types of the document type into the given item. <p>
483      *
484      * @param item the list item to fill
485      * @param detailId the id for the detail to fill
486      *
487      */
488     private void fillDetailMimetypes(CmsListItem item, String detailId) {
489
490         CmsSearchManager searchManager = OpenCms.getSearchManager();
491         StringBuffer html = new StringBuffer ();
492
493         String doctypeName = (String )item.get(LIST_COLUMN_NAME);
494         CmsSearchDocumentType docType = searchManager.getDocumentTypeConfig(doctypeName);
495
496         // output of mime types
497 Iterator itMimetypes = docType.getMimeTypes().iterator();
498         html.append("<ul>\n");
499         while (itMimetypes.hasNext()) {
500             html.append(" <li>\n").append(" ").append(itMimetypes.next()).append("\n");
501             html.append(" </li>");
502         }
503
504         html.append("</ul>\n");
505         item.set(detailId, html.toString());
506     }
507
508     /**
509      * Fills details about resource types of the document type into the given item. <p>
510      *
511      * @param item the list item to fill
512      * @param detailId the id for the detail to fill
513      *
514      */
515     private void fillDetailResourceTypes(CmsListItem item, String detailId) {
516
517         CmsSearchManager searchManager = OpenCms.getSearchManager();
518         StringBuffer html = new StringBuffer ();
519
520         String doctypeName = (String )item.get(LIST_COLUMN_NAME);
521         CmsSearchDocumentType docType = searchManager.getDocumentTypeConfig(doctypeName);
522
523         // output of resource types
524 Iterator itResourcetypes = docType.getResourceTypes().iterator();
525         html.append("<ul>\n");
526         while (itResourcetypes.hasNext()) {
527             html.append(" <li>\n").append(" ").append(itResourcetypes.next()).append("\n");
528             html.append(" </li>");
529         }
530
531         html.append("</ul>\n");
532         item.set(detailId, html.toString());
533     }
534 }

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags