litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Changing VClassGroupCache to not filter out groups and classes with no individuals as part of NIHVIVO-1666 Fixing URLs in browse widget as part of NIHVIVO-592

Browse source
This commit is contained in:
bdc34 2011-01-12 20:00:42 +00:00
parent dea0385806
commit b024863f42
8 changed files with 277 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

13
webapp/src/edu/cornell/mannlib/vitro/webapp/beans/VClassGroup.java
View file

@ -23,6 +23,19 @@ public class VClassGroup extends LinkedList <VClass> implements Comparable<VClas
private String localName = null;
private String publicName = null;
private int displayRank = -1;
private int individualCount = -1;
public boolean isIndividualCountSet(){
return individualCount >= 0;
}
public int getIndividualCount() {
return individualCount;
}
public void setIndividualCount(int individualCount) {
this.individualCount = individualCount;
}
public int getDisplayRank() {
return displayRank;

82
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/JSONServlet.java
View file

@ -13,6 +13,7 @@ import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
@ -78,10 +79,56 @@ public class JSONServlet extends VitroHttpServlet {
}
private void getLuceneIndividualsByVClass( HttpServletRequest req, HttpServletResponse resp ){
String errorMessage = null;
JSONObject rObj = null;
try{
VitroRequest vreq = new VitroRequest(req);
VClass vclass=null;
String vitroClassIdStr = vreq.getParameter("vclassId");
if ( vitroClassIdStr != null && !vitroClassIdStr.isEmpty()){
vclass = vreq.getWebappDaoFactory().getVClassDao().getVClassByURI(vitroClassIdStr);
if (vclass == null) {
log.debug("Couldn't retrieve vclass ");
throw new Exception (errorMessage = "Class " + vitroClassIdStr + " not found");
}
}else{
log.debug("parameter vclassId URI parameter expected ");
throw new Exception("parameter vclassId URI parameter expected ");
}
rObj = getLuceneIndividualsByVClass(vclass.getURI(),req,resp,getServletContext());
}catch(Exception ex){
errorMessage = ex.toString();
log.error(ex,ex);
}
if( rObj == null )
rObj = new JSONObject();
try{
resp.setCharacterEncoding("UTF-8");
resp.setContentType("application/json;charset=UTF-8");
if( errorMessage != null ){
rObj.put("errorMessage", errorMessage);
resp.setStatus(500 /*HttpURLConnection.HTTP_SERVER_ERROR*/);
}else{
rObj.put("errorMessage", "");
}
Writer writer = resp.getWriter();
writer.write(rObj.toString());
}catch(JSONException jse){
log.error(jse,jse);
} catch (IOException e) {
log.error(e,e);
}
}
protected static JSONObject getLuceneIndividualsByVClass(String vclassURI, HttpServletRequest req, HttpServletResponse resp, ServletContext context) throws Exception {
VitroRequest vreq = new VitroRequest(req);
String errorMessage = null;
String message = null;
VClass vclass=null;
JSONObject rObj = new JSONObject();
@ -111,13 +158,12 @@ public class JSONServlet extends VitroHttpServlet {
WebappDaoFactory fullWdf = vreq.getFullWebappDaoFactory();
try {
String vitroClassIdStr = vreq.getParameter("vclassId");
if ( vitroClassIdStr != null && !vitroClassIdStr.isEmpty()){
vclass = vreq.getWebappDaoFactory().getVClassDao().getVClassByURI(vitroClassIdStr);
if (vclass == null) {
log.debug("Couldn't retrieve vclass ");
throw new Exception (errorMessage = "Class " + vitroClassIdStr + " not found");
throw new Exception ("Class " + vitroClassIdStr + " not found");
}
}else{
log.debug("parameter vclassId URI parameter expected ");
@ -138,7 +184,7 @@ public class JSONServlet extends VitroHttpServlet {
vreq.getPortal(),
vreq.getWebappDaoFactory().getPortalDao().isSinglePortal(),
vreq.getWebappDaoFactory().getIndividualDao(),
getServletContext());
context);
rObj.put("totalCount", map.get("totalCount"));
rObj.put("alpha", map.get("alpha"));
@ -189,31 +235,11 @@ public class JSONServlet extends VitroHttpServlet {
rObj.put("letters", jletters);
}
}catch(Exception ex){
errorMessage = ex.getMessage();
}
try{
resp.setCharacterEncoding("UTF-8");
resp.setContentType("application/json;charset=UTF-8");
if( errorMessage != null ){
rObj.put("errorMessage", errorMessage);
resp.setStatus(500 /*HttpURLConnection.HTTP_SERVER_ERROR*/);
}else{
rObj.put("errorMessage", "");
}
Writer writer = resp.getWriter();
writer.write(rObj.toString());
}catch(JSONException jse){
log.error(jse,jse);
} catch (IOException e) {
log.error(e,e);
}
return;
return rObj;
}
private String getVClassName(Individual ind, String moniker,
private static String getVClassName(Individual ind, String moniker,
WebappDaoFactory fullWdf) {
/* so the moniker frequently has a vclass name in it. Try to return
* the vclass name that is the same as the moniker so that the templates
@ -239,7 +265,7 @@ public class JSONServlet extends VitroHttpServlet {
return "";
}
String getDataPropertyValue(Individual ind, DataProperty dp, WebappDaoFactory wdf){
static String getDataPropertyValue(Individual ind, DataProperty dp, WebappDaoFactory wdf){
List<Literal> values = wdf.getDataPropertyStatementDao()
.getDataPropertyValuesForIndividualByProperty(ind, dp);
if( values == null || values.isEmpty() )

18
webapp/src/edu/cornell/mannlib/vitro/webapp/dao/jena/VClassGroupCache.java
View file

@ -79,6 +79,20 @@ public class VClassGroupCache implements ServletContextListener{
return getGroups(getVCGDao(),portalId );
}
/**
* May return null.
*/
public VClassGroup getGroup( int portalId, String vClassGroupURI ){
if( vClassGroupURI == null || vClassGroupURI.isEmpty() )
return null;
List<VClassGroup> cgList = getGroups(portalId);
for( VClassGroup cg : cgList ){
if( vClassGroupURI.equals( cg.getURI()))
return cg;
}
return null;
}
public void clearGroupCache(){
_groupListMap = new ConcurrentHashMap<Integer, List<VClassGroup>>();
}
@ -90,13 +104,13 @@ public class VClassGroupCache implements ServletContextListener{
log.debug("needed to build vclassGroups for portal " + portalId);
// Get all classgroups, each populated with a list of their member vclasses
List<VClassGroup> groups =
vcgDao.getPublicGroupsWithVClasses(ORDER_BY_DISPLAYRANK, !INCLUDE_UNINSTANTIATED, includeIndividualCount);
vcgDao.getPublicGroupsWithVClasses(ORDER_BY_DISPLAYRANK, INCLUDE_UNINSTANTIATED, includeIndividualCount);
// remove classes that have been configured to be hidden from search results
vcgDao.removeClassesHiddenFromSearch(groups);
// now cull out the groups with no populated classes
vcgDao.removeUnpopulatedGroups(groups);
//vcgDao.removeUnpopulatedGroups(groups);
return groups;
} else {

14
webapp/src/edu/cornell/mannlib/vitro/webapp/dao/jena/VClassGroupDaoJena.java
View file

@ -158,9 +158,13 @@ public class VClassGroupDaoJena extends JenaBaseDao implements VClassGroupDao {
}
*/
if (groups.size()>0) {
if( getIndividualCount )
addIndividualCountToGroups(groups);
return groups;
} else {
classDao.addVClassesToGroups(groups);
if( getIndividualCount )
addIndividualCountToGroups(groups);
return groups;
}
} finally {
@ -169,6 +173,16 @@ public class VClassGroupDaoJena extends JenaBaseDao implements VClassGroupDao {
}
private void addIndividualCountToGroups( List<VClassGroup> cgList ){
for( VClassGroup cg : cgList){
int count = 0;
for( VClass vc : cg){
count = count + vc.getEntityCount();
}
cg.setIndividualCount(count);
}
}
public VClassGroup groupFromGroupIndividual(Individual groupInd) {
if (groupInd==null) {
return null;

42
webapp/src/edu/cornell/mannlib/vitro/webapp/utils/pageDataGetter/ClassGroupPageData.java
View file

@ -16,6 +16,7 @@ import edu.cornell.mannlib.vitro.webapp.beans.VClassGroup;
import edu.cornell.mannlib.vitro.webapp.controller.VitroRequest;
import edu.cornell.mannlib.vitro.webapp.dao.DisplayVocabulary;
import edu.cornell.mannlib.vitro.webapp.dao.jena.VClassGroupCache;
import edu.cornell.mannlib.vitro.webapp.web.templatemodels.VClassGroupTemplateModel;
/**
* This will pass these variables to the template:
@ -67,12 +68,51 @@ public class ClassGroupPageData implements PageDataGetter{
return data;
}
public static VClassGroupTemplateModel getClassGroup(String classGroupUri, ServletContext context, VitroRequest vreq){
VClassGroupCache vcgc = VClassGroupCache.getVClassGroupCache(context);
List<VClassGroup> vcgList = vcgc.getGroups(vreq.getPortalId());
VClassGroup group = null;
for( VClassGroup vcg : vcgList){
if( vcg.getURI() != null && vcg.getURI().equals(classGroupUri)){
group = vcg;
break;
}
}
if( classGroupUri != null && !classGroupUri.isEmpty() && group == null ){
/*This could be for two reasons: one is that the classgroup doesn't exist
* The other is that there are no individuals in any of the classgroup's classes */
group = vreq.getWebappDaoFactory().getVClassGroupDao().getGroupByURI(classGroupUri);
if( group != null ){
List<VClassGroup> vcgFullList = vreq.getWebappDaoFactory().getVClassGroupDao()
.getPublicGroupsWithVClasses(false, true, false);
for( VClassGroup vcg : vcgFullList ){
if( classGroupUri.equals(vcg.getURI()) ){
group = vcg;
break;
}
}
if( group == null ){
log.error("Cannot get classgroup '" + classGroupUri + "'");
return null;
}else{
setAllClassCountsToZero(group);
}
}else{
log.error("classgroup " + classGroupUri + " does not exist in the system");
return null;
}
}
return new VClassGroupTemplateModel(group);
}
public String getType(){
return DisplayVocabulary.CLASSGROUP_PAGE_TYPE;
}
protected void setAllClassCountsToZero(VClassGroup vcg){
protected static void setAllClassCountsToZero(VClassGroup vcg){
for(VClass vc : vcg){
vc.setEntityCount(0);
}

12
webapp/src/edu/cornell/mannlib/vitro/webapp/web/templatemodels/VClassGroupTemplateModel.java
View file

@ -54,4 +54,16 @@ public class VClassGroupTemplateModel extends BaseTemplateModel {
return classes;
}
public String getIndividualCount(){
if( vClassGroup.isIndividualCountSet() )
return Integer.toString(vClassGroup.getIndividualCount());
else
return "";
}
public boolean isIndividualCountSet(){
return vClassGroup.isIndividualCountSet();
}
}

51
webapp/src/edu/cornell/mannlib/vitro/webapp/web/widgets/BrowseWidget.java
View file

@ -18,6 +18,7 @@ import edu.cornell.mannlib.vitro.webapp.beans.Individual;
import edu.cornell.mannlib.vitro.webapp.beans.VClass;
import edu.cornell.mannlib.vitro.webapp.beans.VClassGroup;
import edu.cornell.mannlib.vitro.webapp.controller.VitroRequest;
import edu.cornell.mannlib.vitro.webapp.dao.jena.VClassGroupCache;
import edu.cornell.mannlib.vitro.webapp.web.templatemodels.VClassGroupTemplateModel;
import edu.cornell.mannlib.vitro.webapp.web.templatemodels.VClassTemplateModel;
import edu.cornell.mannlib.vitro.webapp.web.templatemodels.individual.IndividualTemplateModel;
@ -61,7 +62,7 @@ public class BrowseWidget extends Widget {
protected WidgetTemplateValues doAllClassGroupsDisplay(Environment env, Map params,
HttpServletRequest request, ServletContext context) {
Map<String,Object> body = getAllClassGroupData(request, params);
Map<String,Object> body = getAllClassGroupData(request, params, context);
try {
body.put("urls",env.getDataModel().get("urls"));
body.put("currentPage", env.getDataModel().get("currentPage"));
@ -73,29 +74,36 @@ public class BrowseWidget extends Widget {
return new WidgetTemplateValues(macroName, body);
}
protected Map<String,Object> getAllClassGroupData(HttpServletRequest request, Map params){
/**
* Gets a list of all VClassGroups with vclasses with individual counts.
*/
protected Map<String,Object> getAllClassGroupData(HttpServletRequest request, Map params, ServletContext context){
Map<String,Object> map = new HashMap<String,Object>();
VitroRequest vreq = new VitroRequest(request);
List<VClassGroup> classGroups =
vreq.getWebappDaoFactory().getVClassGroupDao().getPublicGroupsWithVClasses();
LinkedList<VClassGroupTemplateModel> cgList = new LinkedList<VClassGroupTemplateModel>();
for( VClassGroup classGroup : classGroups){
cgList.add( new VClassGroupTemplateModel( classGroup ));
VClassGroupCache vcgc = VClassGroupCache.getVClassGroupCache(context);
List<VClassGroup> cgList = vcgc.getGroups(vreq.getPortalId());
// List<VClassGroup> classGroups =
// vreq.getWebappDaoFactory().getVClassGroupDao().getPublicGroupsWithVClasses();
//
LinkedList<VClassGroupTemplateModel> cgtmList = new LinkedList<VClassGroupTemplateModel>();
for( VClassGroup classGroup : cgList){
cgtmList.add( new VClassGroupTemplateModel( classGroup ));
}
map.put("vclassGroupList",cgList);
map.put("vclassGroupList",cgtmList);
return map;
}
protected WidgetTemplateValues doClassDisplay(Environment env, Map params,
HttpServletRequest request, ServletContext context) {
Map<String,Object> body = getClassData(request,params);
Map<String,Object> body = getClassData(request,params,context);
try {
body.put("urls",env.getDataModel().get("urls"));
body.put("urlMapping",env.getDataModel().get("urlMapping"));
body.put("currentPage", env.getDataModel().get("currentPage"));
} catch (TemplateModelException e) {
// TODO Auto-generated catch block
e.printStackTrace();
@ -104,10 +112,10 @@ public class BrowseWidget extends Widget {
return new WidgetTemplateValues(macroName, body);
}
private Map<String, Object> getClassData(HttpServletRequest request, Map params) {
private Map<String, Object> getClassData(HttpServletRequest request, Map params, ServletContext context) {
Map<String,Object> map = new HashMap<String,Object>();
map.putAll(getClassGroupData(request, params));
map.putAll(getClassGroupData(request, params,context));
String classUri = getParam(Mode.VCLASS, request, params);
VitroRequest vreq = new VitroRequest(request);
@ -129,11 +137,11 @@ public class BrowseWidget extends Widget {
protected WidgetTemplateValues doClassGroupDisplay(Environment env,
Map params, HttpServletRequest request, ServletContext context) {
Map<String,Object> body = getClassGroupData(request,params);
Map<String,Object> body = getClassGroupData(request,params, context);
try {
body.put("urls",env.getDataModel().get("urls"));
body.put("urlMapping",env.getDataModel().get("urlMapping"));
body.put("currentPage", env.getDataModel().get("currentPage"));
} catch (TemplateModelException e) {
// TODO Auto-generated catch block
e.printStackTrace();
@ -142,14 +150,17 @@ public class BrowseWidget extends Widget {
return new WidgetTemplateValues(macroName, body);
}
protected Map<String, Object> getClassGroupData(HttpServletRequest request, Map params) {
protected Map<String, Object> getClassGroupData(HttpServletRequest request, Map params, ServletContext context) {
Map<String,Object> map = new HashMap<String,Object>();
String vcgName = getParam(Mode.CLASS_GROUP, request, params);
String vcgUri = getParam(Mode.CLASS_GROUP, request, params);
VitroRequest vreq = new VitroRequest(request);
VClassGroup vcg = vreq.getWebappDaoFactory().getVClassGroupDao().getGroupByName(vcgName);
//VClassGroup vcg = vreq.getWebappDaoFactory().getVClassGroupDao().getGroupByURI(vcgUri);
vreq.getWebappDaoFactory().getVClassDao().addVClassesToGroup(vcg, false, true);
VClassGroupCache vcgc = VClassGroupCache.getVClassGroupCache(context);
VClassGroup vcg = vcgc.getGroup(vreq.getPortalId(), vcgUri);
//vreq.getWebappDaoFactory().getVClassDao().addVClassesToGroup(vcg, false, true);
ArrayList<VClassTemplateModel> classes = new ArrayList<VClassTemplateModel>(vcg.size());
for( VClass vc : vcg){
classes.add(new VClassTemplateModel(vc));
@ -157,7 +168,7 @@ public class BrowseWidget extends Widget {
map.put("classes", classes);
map.put("classGroup", new VClassGroupTemplateModel(vcg));
map.put("classGroupName", vcgName);
map.put("classGroupName", vcg.getPublicName());
map.put("classGroupUri", vcg.getURI());
return map;
@ -166,7 +177,7 @@ public class BrowseWidget extends Widget {
enum Mode{
VCLASS_ALPHA("vclassAlpha","vclassAlpha"),
VCLASS("vclass","vclassUri"),
CLASS_GROUP("classGroup","classGroup"),
CLASS_GROUP("classGroup","classgroupUri"),
ALL_CLASS_GROUPS("allClassGroups","all");
String macroName;

31
webapp/web/templates/freemarker/widgets/widget-browse.ftl
View file

@ -16,41 +16,41 @@
<ul id="browse-classgroups" role="list">
<#list vclassGroupList as group>
<li role="listitem"><a href="${urls.base}/${currentPage}?classgroupUri=${group.publicName?url}">${group.publicName} <span class="count-classes">(n)</span></a></li>
<li role="listitem"><a href="${urls.base}/${currentPage}?classgroupUri=${group.uri?url}">${group.publicName} <span class="count-classes">(n)</span></a></li>
</#list>
</ul>
</section>
</#macro>
<#macro classGroup>
<section>
<#--<h2>Macro classGroup from widget-browse.ftl</h2>
<section id="browse" role="region">
<h4>Browse</h4>
<div>
There are ${classes?size} classes in classGroup ${classGroup.publicName}.
Only classes with instances are included.
</div>-->
There are ${classGroup.individualCount} individuals in the class group.
Classes with and without instances are included.
</div>-
<nav role="navigation">
<ul id="foaf-person-childClasses">
<#list classes as class>
<li><a href="${urls.base}/${currentPage}?classgroupUri=${classGroup.publicName?url}&vclassUri=${class.uri?url}">${class.name}<span class="count-classes"> ${class.individualCount}</span></a></li>
<li><a href="${urls.base}/${currentPage}?classgroupUri=${classGroup.uri?url}&vclassUri=${class.uri?url}">${class.name}<span class="count-classes"> ${class.individualCount}</span></a></li>
</#list>
</ul>
</nav>
<#--<ul>
<#list classes as class>
<li><a href="${urls.base}/${currentPage}?classgroupUri=${classGroup.publicName?url}&vclassUri=${class.uri?url}">${class.name}</a> ${class.individualCount}</li>
</#list>
</ul>-->
</section>
</#macro>
<#macro vclass>
<section>
<h2>vclass ${class.name} from ${classGroup.publicName}</h2>
<section id="browse" role="region">
<h4>Browse</h4>
<div>
vclass ${class.name} from ${classGroup.publicName}
This has classGroup, classes, individualsInClass and class.
</div>
<ul>
<#list individualsInClass as ind>
@ -60,7 +60,8 @@
</#macro>
<#macro vclassAlpha>
<section role="region">
<h2>vclassAlpha</h2>
<section id="browse" role="region">
<h4>Browse</h4>
<div>vclassAlpha is not yet implemented.</div>
</section>
</#macro>