View Javadoc
1   /*
2    * This file is part of ***  M y C o R e  ***
3    * See http://www.mycore.de/ for details.
4    *
5    * MyCoRe is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * MyCoRe 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
13   * GNU General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License
16   * along with MyCoRe.  If not, see <http://www.gnu.org/licenses/>.
17   */
18  
19  package org.mycore.datamodel.objectinfo;
20  
21  import org.mycore.common.config.MCRConfiguration2;
22  import org.mycore.datamodel.common.MCRObjectIDDate;
23  import org.mycore.datamodel.metadata.MCRObjectID;
24  
25  import java.util.List;
26  
27  /**
28   * Allows to query objects using {@link MCRObjectQuery}.
29   */
30  public interface MCRObjectQueryResolver {
31  
32      /**
33       * Gets all object info which match the restrictions of the query
34       * @param objectQuery the query
35       * @return the ids of the objects
36       */
37      List<MCRObjectID> getIds(MCRObjectQuery objectQuery);
38  
39      /**
40       * Gets all the object info which match the restrictions of the query
41       * @param objectQuery the query
42       * @return the ids and dates of the object info
43       */
44      List<MCRObjectIDDate> getIdDates(MCRObjectQuery objectQuery);
45  
46      /**
47       * Gets all the object info which match the restrictions of the query
48       * @param objectQuery the query
49       * @return the info
50       */
51      List<MCRObjectInfo> getInfos(MCRObjectQuery objectQuery);
52  
53      /**
54       * Gets the count of object info which match the restrictions of query ignoring limit and offset
55       * @param objectQuery the query
56       * @return the count of the object info
57       */
58      int count(MCRObjectQuery objectQuery);
59  
60      static MCRObjectQueryResolver getInstance() {
61          return InstanceHolder.RESOLVER;
62      }
63  
64      class InstanceHolder {
65          private static final String QUERY_RESOLVER_CLASS_PROPERTY = "MCR.Object.QueryResolver.Class";
66  
67          private static final MCRObjectQueryResolver RESOLVER
68              = MCRConfiguration2.<MCRObjectQueryResolver>getSingleInstanceOf(QUERY_RESOLVER_CLASS_PROPERTY)
69                  .orElseThrow(() -> MCRConfiguration2.createConfigurationException(QUERY_RESOLVER_CLASS_PROPERTY));
70      }
71  }