File HiddenSpaceFilter.java
Coverage histogram
0% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| HiddenSpaceFilter | 37 | 2 | 0% | 2 | 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 javax.inject.Named; | |
| 23 | ||
| 24 | import org.xwiki.component.annotation.Component; | |
| 25 | ||
| 26 | /** | |
| 27 | * Query filter excluding 'hidden' spaces from a {@link org.xwiki.query.Query}. Hidden spaces should not be | |
| 28 | * returned in public search results or appear in the User Interface in general. | |
| 29 | * <p> | |
| 30 | * The filter assume the <code>XWikiSpace</code> table has a <code>space</code> alias. | |
| 31 | * | |
| 32 | * @version $Id: 9074ba2e04b3e209bd26130bf734212314646843 $ | |
| 33 | * @since 7.2M2 | |
| 34 | */ | |
| 35 | @Component | |
| 36 | @Named("hidden/space") | |
| 37 | public class HiddenSpaceFilter extends AbstractHiddenFilter | |
| 38 | { | |
| 39 | 25 |  @Override |
| 40 | protected boolean isFilterable(String statement) | |
| 41 | { | |
| 42 | // This could be replaced by the following regex: "xwikispace(\\s)+(as)?(\\s)+space" | |
| 43 | 25 | return statement.indexOf("xwikispace as space") > -1 || statement.indexOf("xwikispace space") > -1; |
| 44 | } | |
| 45 | ||
| 46 | 26 | @Override |
| 47 | protected String filterHidden(String statement, String language) | |
| 48 | { | |
| 49 | 26 | return insertWhereClause("space.hidden <> true", statement, language); |
| 50 | } | |
| 51 | } |