File HiddenDocumentFilter.java
Coverage histogram
0% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| HiddenDocumentFilter | 36 | 1 | 0% | 1 | 0 |
Contributing tests
This file is covered by 9 tests.
.
Source view
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package org.xwiki.query.internal; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.Component; | |
| 23 | ||
| 24 | /** | |
| 25 | * Query filter excluding 'hidden' documents from a {@link org.xwiki.query.Query}. Hidden documents should not be | |
| 26 | * returned in public search results or appear in the User Interface in general. | |
| 27 | * <p> | |
| 28 | * The filter assume the <code>XWikiDocument</code> table has a <code>space</code> alias. | |
| 29 | * <p> | |
| 30 | * Starting with 7.2M2, the 'hidden' hint is deprecated in favor of the 'hidden/document' one. | |
| 31 | * | |
| 32 | * @version $Id: 68084dc2610d238eb5c4372d11a761e56c4d2949 $ | |
| 33 | * @since 4.0RC1 | |
| 34 | */ | |
| 35 | @Component(hints = {"hidden", HiddenDocumentFilter.HINT}) | |
| 36 | public class HiddenDocumentFilter extends AbstractHiddenFilter | |
| 37 | { | |
| 38 | /** | |
| 39 | * The role hint of that component. | |
| 40 | */ | |
| 41 | public static final String HINT = "hidden/document"; | |
| 42 | ||
| 43 | 780 |  @Override |
| 44 | protected String filterHidden(String statement, String language) | |
| 45 | { | |
| 46 | 780 | return insertWhereClause("(doc.hidden <> true or doc.hidden is null)", statement, language); |
| 47 | } | |
| 48 | } |