inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-14 17:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged 5.2.N (5.2.1) to HEAD (5.2)

Browse Source 
132107 gjames: SEARCH-227: Adding additional display information for facetting api


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@132335 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Alan Davis
2016-11-03 14:04:21 +00:00
parent 0e5f80f4eb
commit d6e678d2c2
11 changed files with 362 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
config/alfresco/public-rest-context.xml
View File

@@ -736,6 +736,39 @@
</property>
</bean>
<bean id="publicapi.mimeTypePropertyLookup" class="org.alfresco.rest.api.lookups.MimeTypePropertyLookup">
<property name="serviceRegistry" ref="ServiceRegistry"/>
<property name="supported">
<list>
<value>cm:content.mimetype</value>
<value>content.mimetype</value>
</list>
</property>
</bean>
<bean id="publicapi.personPropertyLookup" class="org.alfresco.rest.api.lookups.PersonPropertyLookup">
<property name="serviceRegistry" ref="ServiceRegistry"/>
<property name="supported">
<list>
<value>cm:creator</value>
<value>cm:modifier</value>
<value>cm:owner</value>
<value>creator</value>
<value>modifier</value>
<value>owner</value>
</list>
</property>
</bean>
<bean id="publicapi.propertyLookups" class="org.alfresco.rest.api.lookups.PropertyLookupRegistry">
<property name="lookups">
<list>
<ref bean="publicapi.personPropertyLookup" />
<ref bean="publicapi.mimeTypePropertyLookup" />
</list>
</property>
</bean>
<!-- API webscripts -->
<bean class="org.alfresco.rest.api.sites.SiteEntityResource">
@@ -858,7 +891,14 @@
<property name="serviceRegistry" ref="ServiceRegistry" />
<property name="assistant" ref="apiAssistant" />
<property name="helper" ref="webscriptHelper" />
<property name="resultMapper" ref="searchapiResultMapper" />
</bean>
<bean id="searchapiResultMapper" class="org.alfresco.rest.api.search.impl.ResultMapper">
<property name="nodes" ref="Nodes" />
<property name="propertyLookup">
<ref bean="publicapi.propertyLookups"/>
</property>
</bean>
<bean id="webscript.org.alfresco.api.DiscoveryApiWebscript.get"

2
source/java/org/alfresco/rest/api/impl/NodesImpl.java
View File

@@ -334,7 +334,7 @@ public class NodesImpl implements Nodes
ContentModel.PROP_AUTO_VERSION_PROPS,
ContentModel.PROP_AUTO_VERSION);
private static final List<QName> PROPS_USERLOOKUP = Arrays.asList(
public static final List<QName> PROPS_USERLOOKUP = Arrays.asList(
ContentModel.PROP_CREATOR,
ContentModel.PROP_MODIFIER,
ContentModel.PROP_OWNER,

71
source/java/org/alfresco/rest/api/lookups/MimeTypePropertyLookup.java Normal file
View File

@@ -0,0 +1,71 @@
/*-
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.rest.api.lookups;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Looks up mimetype values
* Pass in a mimetype value and a display string is returned.
* @author Gethin James
*/
public class MimeTypePropertyLookup implements PropertyLookup<String>
{
private Set<String> supported = new HashSet<>();
private ServiceRegistry serviceRegistry;
@Override
public String lookup(String propertyValue)
{
Map<String,String> mimetypes = serviceRegistry.getMimetypeService().getDisplaysByMimetype();
return mimetypes.get(propertyValue);
}
@Override
public Set<String> supports()
{
return supported;
}
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
this.serviceRegistry = serviceRegistry;
}
public void setSupported(List<String> supported)
{
this.supported.add(QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "content.mimetype").toString());
this.supported.addAll(supported);
}
}

76
source/java/org/alfresco/rest/api/lookups/PersonPropertyLookup.java Normal file
View File

@@ -0,0 +1,76 @@
/*-
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.rest.api.lookups;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.transaction.TransactionalResourceHelper;
import org.alfresco.rest.api.impl.NodesImpl;
import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.api.model.UserInfo;
import org.alfresco.service.ServiceRegistry;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Looks up information about a person.
* Pass in a userId and the display name is returned.
*
* @author Gethin James
*/
public class PersonPropertyLookup implements PropertyLookup<String>
{
private Set<String> supported = new HashSet<>();
private ServiceRegistry serviceRegistry;
@Override
public String lookup(String propertyValue)
{
Map<String, UserInfo> mapUserInfo = TransactionalResourceHelper.getMap("PERSON_PROPERTY_LOOKUP_USER_INFO_CACHE");
UserInfo user = Node.lookupUserInfo(propertyValue, mapUserInfo, serviceRegistry.getPersonService());
if (user != null) return user.getDisplayName();
return null;
}
@Override
public Set<String> supports()
{
return supported;
}
public void setSupported(List<String> supported)
{
NodesImpl.PROPS_USERLOOKUP.forEach(entry -> this.supported.add(entry.toString()));
this.supported.addAll(supported);
}
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
this.serviceRegistry = serviceRegistry;
}
}

52
source/java/org/alfresco/rest/api/lookups/PropertyLookup.java Normal file
View File

@@ -0,0 +1,52 @@
/*-
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.rest.api.lookups;
import java.util.List;
import java.util.Set;
/**
* Looks up property values for the api
*
* @author Gethin James
*/
public interface PropertyLookup<T extends Object>
{
/**
* The list of property keys that are supported by this class
* @return Set<String> property keys
*/
public Set<String> supports();
/**
* Lookup the property value with a new value.
* @param propertyValue
* @return a new value or null if the property value isn't found.
*/
public T lookup(String propertyValue);
}

88
source/java/org/alfresco/rest/api/lookups/PropertyLookupRegistry.java Normal file
View File

@@ -0,0 +1,88 @@
/*-
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.rest.api.lookups;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.extensions.surf.util.AbstractLifecycleBean;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Acts as a central point for property lookups
*
* @author Gethin James
*/
public class PropertyLookupRegistry
{
private static Log logger = LogFactory.getLog(PropertyLookupRegistry.class);
Map<String, PropertyLookup> propertyLookups = new HashMap<>();
/**
* Set the supported property lookup classes.
* @param lookups
*/
public void setLookups(List<PropertyLookup> lookups)
{
lookups.forEach(entry ->
{
entry.supports().forEach( propKey -> propertyLookups.put((String) propKey, entry) );
});
}
/**
* The list of property keys that are supported by this class
* @return Set<String> property keys
*/
public Set<String> supports()
{
return propertyLookups.keySet();
}
/**
* Looks up the property value using a PropertyLookup
* @param propertyName the property name/type
* @param propertyValue the value to lookup
* @return Object to be serialized as json
*/
public Object lookup(String propertyName, String propertyValue)
{
PropertyLookup lookup = propertyLookups.get(propertyName);
if (lookup != null)
{
return lookup.lookup(propertyValue);
}
return null;
}
}

8
source/java/org/alfresco/rest/api/search/SearchApiWebscript.java
View File

@@ -66,7 +66,6 @@ public class SearchApiWebscript extends AbstractWebScript implements RecognizedP
{
private ServiceRegistry serviceRegistry;
private SearchService searchService;
private Nodes nodes;
private SearchMapper searchMapper;
private ResultMapper resultMapper;
protected ApiAssistant assistant;
@@ -78,10 +77,8 @@ public class SearchApiWebscript extends AbstractWebScript implements RecognizedP
PropertyCheck.mandatory(this, "serviceRegistry", serviceRegistry);
this.searchService = serviceRegistry.getSearchService();
ParameterCheck.mandatory("assistant", this.assistant);
ParameterCheck.mandatory("nodes", this.nodes);
searchMapper = new SearchMapper();
resultMapper = new ResultMapper(nodes);
}
@Override
@@ -145,8 +142,9 @@ public class SearchApiWebscript extends AbstractWebScript implements RecognizedP
return Params.valueOf(null, recognizedParams, null, webScriptRequest);
}
public void setNodes(Nodes nodes) {
this.nodes = nodes;
public void setResultMapper(ResultMapper resultMapper)
{
this.resultMapper = resultMapper;
}
public void setAssistant(ApiAssistant assistant) {

9
source/java/org/alfresco/rest/api/search/context/FacetFieldContext.java
View File

@@ -55,11 +55,18 @@ public class FacetFieldContext
{
private final String label;
private final int count;
private final Object display;
public Bucket(String label, int count)
public Bucket(String label, int count, Object display)
{
this.label = label;
this.count = count;
this.display = display;
}
public Object getDisplay()
{
return display;
}
public String getLabel()

22
source/java/org/alfresco/rest/api/search/impl/ResultMapper.java
View File

@@ -28,22 +28,22 @@ package org.alfresco.rest.api.search.impl;
import org.alfresco.repo.search.impl.lucene.SolrJSONResultSet;
import org.alfresco.rest.api.Nodes;
import org.alfresco.rest.api.lookups.PropertyLookupRegistry;
import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.api.model.UserInfo;
import org.alfresco.rest.api.search.context.FacetFieldContext;
import org.alfresco.rest.api.search.context.FacetFieldContext.Bucket;
import org.alfresco.rest.api.search.context.FacetQueryContext;
import org.alfresco.rest.api.search.context.SearchContext;
import org.alfresco.rest.api.search.context.SpellCheckContext;
import org.alfresco.rest.api.search.model.HighlightEntry;
import org.alfresco.rest.api.search.model.SearchEntry;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
import org.alfresco.rest.api.search.context.SearchContext;
import org.alfresco.rest.api.search.context.FacetQueryContext;
import org.alfresco.rest.framework.resource.parameters.Params;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.SpellCheckResult;
import org.alfresco.util.Pair;
import org.alfresco.util.ParameterCheck;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
@@ -62,12 +62,21 @@ public class ResultMapper
{
private Nodes nodes;
private PropertyLookupRegistry propertyLookup;
private static Log logger = LogFactory.getLog(ResultMapper.class);
public ResultMapper(Nodes nodes)
public ResultMapper()
{
}
public void setNodes(Nodes nodes)
{
this.nodes = nodes;
ParameterCheck.mandatory("nodes", this.nodes);
}
public void setPropertyLookup(PropertyLookupRegistry propertyLookup)
{
this.propertyLookup = propertyLookup;
}
/**
@@ -179,7 +188,8 @@ public class ResultMapper
List<Bucket> buckets = new ArrayList<>(facet.getValue().size());
for (Pair<String, Integer> buck:facet.getValue())
{
buckets.add(new Bucket(buck.getFirst(), buck.getSecond()));
Object display = propertyLookup.lookup(facet.getKey(), buck.getFirst());
buckets.add(new Bucket(buck.getFirst(), buck.getSecond(), display));
}
ffcs.add(new FacetFieldContext(facet.getKey(), buckets));
}

5
source/test-java/org/alfresco/rest/api/search/ResultMapperTests.java
View File

@@ -38,6 +38,7 @@ import org.alfresco.repo.search.EmptyResultSet;
import org.alfresco.repo.search.impl.lucene.SolrJSONResultSet;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.rest.api.impl.NodesImpl;
import org.alfresco.rest.api.lookups.PropertyLookupRegistry;
import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.api.model.UserInfo;
import org.alfresco.rest.api.search.context.FacetFieldContext;
@@ -119,7 +120,9 @@ public class ResultMapperTests
return new Node(aNode, (NodeRef)args[1], nodeProps, mapUserInfo, sr);
}
});
mapper = new ResultMapper(nodes);
mapper = new ResultMapper();
mapper.setNodes(nodes);
mapper.setPropertyLookup(new PropertyLookupRegistry());
}
@Test

6
source/test-java/org/alfresco/rest/api/search/SearchQuerySerializerTests.java
View File

@@ -143,7 +143,7 @@ public class SearchQuerySerializerTests
{
ExecutionResult exec1 = new ExecutionResult(new Farmer("180"),null);
FacetFieldContext ffc = new FacetFieldContext("theLabel", Arrays.asList(new Bucket("b1", 23), new Bucket("b2", 34)));
FacetFieldContext ffc = new FacetFieldContext("theLabel", Arrays.asList(new Bucket("b1", 23, "displayText1"), new Bucket("b2", 34, "displayText2")));
SearchContext searchContext = new SearchContext(23l, Arrays.asList(new FacetQueryContext("f1", 15), new FacetQueryContext("f2", 20)),
Arrays.asList(ffc),
new SpellCheckContext("aFlag", Arrays.asList("bish", "bash")));
@@ -155,8 +155,8 @@ public class SearchQuerySerializerTests
assertTrue("There must 'facetQueries f2' json output", out.contains("{\"label\":\"f2\",\"count\":20}"));
assertTrue("There must 'spellCheck' json output", out.contains("\"spellCheck\":{\"type\":\"aFlag\",\"suggestions\":[\"bish\",\"bash\"]}"));
assertTrue("There must 'facetsFields' json output", out.contains("\"facetsFields\":[{\"label\":\"theLabel\",\"buckets\""));
assertTrue("There must 'bucket1' json output", out.contains("{\"label\":\"b1\",\"count\":23}"));
assertTrue("There must 'bucket2' json output", out.contains("{\"label\":\"b2\",\"count\":34}"));
assertTrue("There must 'bucket1' json output", out.contains("{\"label\":\"b1\",\"count\":23,\"display\":\"displayText1\"}"));
assertTrue("There must 'bucket2' json output", out.contains("{\"label\":\"b2\",\"count\":34,\"display\":\"displayText2\"}"));
searchContext = new SearchContext(-1, null, null, null);
coll = CollectionWithPagingInfo.asPaged(null, Arrays.asList(exec1), false, 2, null, searchContext);