JavaDoc changes required to prevent the release process breaking.
This commit is contained in:
parent
c364dec722
commit
20ab5259c0
24 changed files with 89 additions and 142 deletions
|
@ -5,9 +5,6 @@ public class BaseObject {
|
||||||
/**
|
/**
|
||||||
* Simple JavaBean domain object with an id property.
|
* Simple JavaBean domain object with an id property.
|
||||||
* Used as a base class for objects needing this property.
|
* Used as a base class for objects needing this property.
|
||||||
*
|
|
||||||
* @author Ken Krebs
|
|
||||||
* @author Juergen Hoeller
|
|
||||||
*/
|
*/
|
||||||
private Integer id;
|
private Integer id;
|
||||||
|
|
||||||
|
|
|
@ -17,9 +17,9 @@ public class SemanticServicesError {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param exception
|
* @param exception Exception description
|
||||||
* @param message
|
* @param message Error message
|
||||||
* @param severity
|
* @param severity Severity
|
||||||
*/
|
*/
|
||||||
public SemanticServicesError(String exception, String message, String severity) {
|
public SemanticServicesError(String exception, String message, String severity) {
|
||||||
super();
|
super();
|
||||||
|
|
|
@ -9,21 +9,18 @@ import edu.cornell.mannlib.semservices.bo.Concept;
|
||||||
public interface ExternalConceptService {
|
public interface ExternalConceptService {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param term
|
* @param term Term
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
List<Concept> processResults(String term) throws Exception;
|
List<Concept> processResults(String term) throws Exception;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param term
|
* @param term Term
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
List<Concept> getConcepts(String term) throws Exception;
|
List<Concept> getConcepts(String term) throws Exception;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param uri
|
* @param uri URI
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
List<Concept> getConceptsByURIWithSparql(String uri) throws Exception;
|
List<Concept> getConceptsByURIWithSparql(String uri) throws Exception;
|
||||||
|
|
||||||
|
|
|
@ -481,8 +481,7 @@ public class AgrovocService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param uri
|
* @param uri The URI
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String stripConceptId(String uri) {
|
protected String stripConceptId(String uri) {
|
||||||
String conceptId = new String();
|
String conceptId = new String();
|
||||||
|
@ -492,8 +491,7 @@ public class AgrovocService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param str
|
* @param str The String
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String extractConceptId(String str) {
|
protected String extractConceptId(String str) {
|
||||||
try {
|
try {
|
||||||
|
|
|
@ -75,8 +75,7 @@ public class GemetService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param results
|
* @param results Results to process
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private List<Concept> processOutput(String results) throws Exception {
|
private List<Concept> processOutput(String results) throws Exception {
|
||||||
|
|
||||||
|
@ -145,9 +144,8 @@ public class GemetService implements ExternalConceptService {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a string from a json object or an empty string if there is no value for the given key
|
* Get a string from a json object or an empty string if there is no value for the given key
|
||||||
* @param obj
|
* @param obj JSON Object
|
||||||
* @param key
|
* @param key Key to retrieve
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String getJsonValue(JSONObject obj, String key) {
|
protected String getJsonValue(JSONObject obj, String key) {
|
||||||
if (obj.has(key)) {
|
if (obj.has(key)) {
|
||||||
|
@ -159,8 +157,7 @@ public class GemetService implements ExternalConceptService {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param concept_uri
|
* @param concept_uri Concept URI
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
protected String getAvailableLangs(String concept_uri) throws Exception {
|
protected String getAvailableLangs(String concept_uri) throws Exception {
|
||||||
|
@ -177,8 +174,7 @@ public class GemetService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param concept_uri
|
* @param concept_uri concept URI
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
protected String getConcept(String concept_uri) throws Exception {
|
protected String getConcept(String concept_uri) throws Exception {
|
||||||
|
@ -196,9 +192,8 @@ public class GemetService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param concept_uri
|
* @param concept_uri Concept URI
|
||||||
* @param property
|
* @param property Property
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
protected String getAllTranslationsForConcept(String concept_uri, String property) throws Exception {
|
protected String getAllTranslationsForConcept(String concept_uri, String property) throws Exception {
|
||||||
|
@ -235,9 +230,8 @@ public class GemetService implements ExternalConceptService {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param concept_uri
|
* @param concept_uri Concept URI
|
||||||
* @param relation
|
* @param relation Relations
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
protected String getRelatedConcepts(String concept_uri, String relation) throws Exception {
|
protected String getRelatedConcepts(String concept_uri, String relation) throws Exception {
|
||||||
|
@ -266,8 +260,7 @@ public class GemetService implements ExternalConceptService {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param keyword
|
* @param keyword Keyword
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
protected String getConceptsMatchingKeyword(String keyword) throws Exception {
|
protected String getConceptsMatchingKeyword(String keyword) throws Exception {
|
||||||
|
@ -288,8 +281,7 @@ public class GemetService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param url
|
* @param url URI
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String getGemetResults(String url) throws Exception {
|
protected String getGemetResults(String url) throws Exception {
|
||||||
String results = new String();
|
String results = new String();
|
||||||
|
|
|
@ -221,8 +221,7 @@ public class LCSHService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param uri
|
* @param uri URI
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String stripConceptId(String uri) {
|
protected String stripConceptId(String uri) {
|
||||||
String conceptId = new String();
|
String conceptId = new String();
|
||||||
|
@ -232,8 +231,7 @@ public class LCSHService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param str
|
* @param str String with concept id
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String extractConceptId(String str) {
|
protected String extractConceptId(String str) {
|
||||||
try {
|
try {
|
||||||
|
|
|
@ -97,8 +97,7 @@ public class UMLSService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param uri
|
* @param uri URI
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public List<Concept> getConceptsByURIWithSparql(String uri)
|
public List<Concept> getConceptsByURIWithSparql(String uri)
|
||||||
throws Exception {
|
throws Exception {
|
||||||
|
@ -108,8 +107,7 @@ public class UMLSService implements ExternalConceptService {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param results
|
* @param results Results to process
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private List<Concept> processOutput(String results) throws Exception {
|
private List<Concept> processOutput(String results) throws Exception {
|
||||||
|
|
||||||
|
@ -193,9 +191,8 @@ public class UMLSService implements ExternalConceptService {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a string from a json object or an empty string if there is no value for the given key
|
* Get a string from a json object or an empty string if there is no value for the given key
|
||||||
* @param obj
|
* @param obj JSON Object
|
||||||
* @param key
|
* @param key Key to retrieve
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
protected String getJsonValue(JSONObject obj, String key) {
|
protected String getJsonValue(JSONObject obj, String key) {
|
||||||
if (obj.has(key)) {
|
if (obj.has(key)) {
|
||||||
|
|
|
@ -50,7 +50,6 @@ public class XMLUtils {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
|
||||||
* @throws ParserConfigurationException
|
* @throws ParserConfigurationException
|
||||||
*/
|
*/
|
||||||
public static DocumentBuilder getDocumentBuilder()
|
public static DocumentBuilder getDocumentBuilder()
|
||||||
|
@ -68,8 +67,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param xmlString
|
* @param xmlString XML String
|
||||||
* @return
|
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @throws SAXException
|
* @throws SAXException
|
||||||
* @throws ParserConfigurationException
|
* @throws ParserConfigurationException
|
||||||
|
@ -82,8 +80,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param stream
|
* @param stream Input stream
|
||||||
* @return
|
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @throws SAXException
|
* @throws SAXException
|
||||||
* @throws ParserConfigurationException
|
* @throws ParserConfigurationException
|
||||||
|
@ -94,9 +91,8 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param document
|
* @param document DOM Document
|
||||||
* @param name
|
* @param name Name
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public static String getElementByName(Document document, String name) {
|
public static String getElementByName(Document document, String name) {
|
||||||
NodeList nodes = document.getElementsByTagName(name);
|
NodeList nodes = document.getElementsByTagName(name);
|
||||||
|
@ -109,7 +105,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param doc
|
* @param doc DOM Document
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("deprecation")
|
@SuppressWarnings("deprecation")
|
||||||
|
@ -130,7 +126,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param xml
|
* @param xml XML String
|
||||||
*/
|
*/
|
||||||
public static void prettyPrint(String xml) {
|
public static void prettyPrint(String xml) {
|
||||||
Source xmlInput = new StreamSource(new StringReader(xml));
|
Source xmlInput = new StreamSource(new StringReader(xml));
|
||||||
|
@ -160,7 +156,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param xml
|
* @param xml XML String
|
||||||
*/
|
*/
|
||||||
public static String prettyPrintToString(String xml) {
|
public static String prettyPrintToString(String xml) {
|
||||||
Source xmlInput = new StreamSource(new StringReader(xml));
|
Source xmlInput = new StreamSource(new StringReader(xml));
|
||||||
|
@ -190,7 +186,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param node
|
* @param node DOM Node
|
||||||
*/
|
*/
|
||||||
public static void displayNodeInfo(Node node) {
|
public static void displayNodeInfo(Node node) {
|
||||||
switch (node.getNodeType()) {
|
switch (node.getNodeType()) {
|
||||||
|
@ -222,7 +218,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param node
|
* @param node DOM Node
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
*/
|
*/
|
||||||
public static void serializeNode(Node node) throws IOException {
|
public static void serializeNode(Node node) throws IOException {
|
||||||
|
@ -308,7 +304,7 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param s
|
* @param s String
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
*/
|
*/
|
||||||
private static void print(String s) throws IOException {
|
private static void print(String s) throws IOException {
|
||||||
|
@ -336,8 +332,8 @@ public class XMLUtils {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param doc (either a Document or a Node)
|
* @param obj (either a Document or a Node)
|
||||||
* @param expression
|
* @param expression Expression
|
||||||
* @return string contents
|
* @return string contents
|
||||||
*/
|
*/
|
||||||
public static Node getNodeWithXpath(Object obj, String expression) {
|
public static Node getNodeWithXpath(Object obj, String expression) {
|
||||||
|
|
|
@ -19,8 +19,7 @@ public class VisualizationsDependencyInjector {
|
||||||
* This method is used to inject vis dependencies i.e. the vis algorithms that are
|
* This method is used to inject vis dependencies i.e. the vis algorithms that are
|
||||||
* being implemented into the vis controller. Modified Dependency Injection pattern is
|
* being implemented into the vis controller. Modified Dependency Injection pattern is
|
||||||
* used here. XML file containing the location of all the vis is saved in accessible folder.
|
* used here. XML file containing the location of all the vis is saved in accessible folder.
|
||||||
* @param servletContext
|
* @param servletContext Servlet context
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private synchronized static Map<String, VisualizationRequestHandler> initVisualizations(
|
private synchronized static Map<String, VisualizationRequestHandler> initVisualizations(
|
||||||
ServletContext servletContext) {
|
ServletContext servletContext) {
|
||||||
|
|
|
@ -556,9 +556,9 @@ public class AddGrantRoleToPersonGenerator implements EditConfigurationGenerator
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepare edit configuration for update
|
* Prepare edit configuration for update
|
||||||
* @param vreq
|
* @param vreq - current VitroRequest
|
||||||
* @param session
|
* @param session - the HTTP session
|
||||||
* @param editConfiguration
|
* @param editConfiguration - Edit configuration
|
||||||
*/
|
*/
|
||||||
|
|
||||||
private void prepareForUpdate(VitroRequest vreq, HttpSession session, EditConfigurationVTwo editConfiguration) {
|
private void prepareForUpdate(VitroRequest vreq, HttpSession session, EditConfigurationVTwo editConfiguration) {
|
||||||
|
|
|
@ -436,7 +436,6 @@ public abstract class AddRoleToPersonTwoStageGenerator extends BaseEditConfigura
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility method for subclasses to make a query for type from a ChildVClassesOptions object.
|
* Utility method for subclasses to make a query for type from a ChildVClassesOptions object.
|
||||||
* @throws Exception
|
|
||||||
*/
|
*/
|
||||||
protected String getActivityTypeQueryForChildVClassOptions(VitroRequest vreq, ChildVClassesOptions opts){
|
protected String getActivityTypeQueryForChildVClassOptions(VitroRequest vreq, ChildVClassesOptions opts){
|
||||||
log.debug("objectClassUri = " + opts.getClassUri());
|
log.debug("objectClassUri = " + opts.getClassUri());
|
||||||
|
@ -447,7 +446,6 @@ public abstract class AddRoleToPersonTwoStageGenerator extends BaseEditConfigura
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility method for subclasses to make a query for type from a IndividualsViaClassGroupOptions object.
|
* Utility method for subclasses to make a query for type from a IndividualsViaClassGroupOptions object.
|
||||||
* @throws Exception
|
|
||||||
*/
|
*/
|
||||||
protected String getActivityTypeQueryForIndividualsViaClassGroupOptions(VitroRequest vreq, IndividualsViaClassGroupOptions opts){
|
protected String getActivityTypeQueryForIndividualsViaClassGroupOptions(VitroRequest vreq, IndividualsViaClassGroupOptions opts){
|
||||||
log.debug("ClassGroupUri = " + opts.getClassGroupUri());
|
log.debug("ClassGroupUri = " + opts.getClassGroupUri());
|
||||||
|
|
|
@ -177,8 +177,7 @@ public class CoAuthorshipRequestHandler implements VisualizationRequestHandler {
|
||||||
/**
|
/**
|
||||||
* Provides response when a csv file containing number & names of unique co-authors per
|
* Provides response when a csv file containing number & names of unique co-authors per
|
||||||
* year is requested.
|
* year is requested.
|
||||||
* @param authorNodesAndEdges
|
* @param authorNodesAndEdges Author nodes and edges
|
||||||
* @param response
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareCoauthorsCountPerYearDataResponse(
|
private Map<String, String> prepareCoauthorsCountPerYearDataResponse(
|
||||||
CollaborationData authorNodesAndEdges) {
|
CollaborationData authorNodesAndEdges) {
|
||||||
|
@ -214,8 +213,7 @@ public class CoAuthorshipRequestHandler implements VisualizationRequestHandler {
|
||||||
/**
|
/**
|
||||||
* Provides response when a csv file containing number & names of unique co-authors per
|
* Provides response when a csv file containing number & names of unique co-authors per
|
||||||
* year is requested.
|
* year is requested.
|
||||||
* @param authorNodesAndEdges
|
* @param coAuthorshipData Co authorship data
|
||||||
* @param response
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareCoauthorsListDataResponse(
|
private Map<String, String> prepareCoauthorsListDataResponse(
|
||||||
CollaborationData coAuthorshipData) {
|
CollaborationData coAuthorshipData) {
|
||||||
|
@ -246,8 +244,7 @@ public class CoAuthorshipRequestHandler implements VisualizationRequestHandler {
|
||||||
/**
|
/**
|
||||||
* Provides a response when graphml formatted co-authorship network is requested, typically by
|
* Provides a response when graphml formatted co-authorship network is requested, typically by
|
||||||
* the flash vis.
|
* the flash vis.
|
||||||
* @param authorNodesAndEdges
|
* @param authorNodesAndEdges Author nodes and edges
|
||||||
* @param response
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareNetworkStreamDataResponse(
|
private Map<String, String> prepareNetworkStreamDataResponse(
|
||||||
CollaborationData authorNodesAndEdges) {
|
CollaborationData authorNodesAndEdges) {
|
||||||
|
|
|
@ -62,8 +62,8 @@ public class CoAuthorshipVisCodeGenerator {
|
||||||
/**
|
/**
|
||||||
* This method is used to setup parameters for the sparkline value object. These parameters
|
* This method is used to setup parameters for the sparkline value object. These parameters
|
||||||
* will be used in the template to construct the actual html/javascript code.
|
* will be used in the template to construct the actual html/javascript code.
|
||||||
* @param visMode
|
* @param visMode Visualization mode
|
||||||
* @param visContainer
|
* @param providedVisContainerID Container ID
|
||||||
*/
|
*/
|
||||||
private SparklineData setupSparklineParameters(String visMode,
|
private SparklineData setupSparklineParameters(String visMode,
|
||||||
String providedVisContainerID) {
|
String providedVisContainerID) {
|
||||||
|
|
|
@ -174,8 +174,7 @@ public class CoPIGrantCountRequestHandler implements VisualizationRequestHandler
|
||||||
/**
|
/**
|
||||||
* Provides response when a csv file containing number & names of unique co-pis per
|
* Provides response when a csv file containing number & names of unique co-pis per
|
||||||
* year is requested.
|
* year is requested.
|
||||||
* @param piNodesAndEdges
|
* @param piNodesAndEdges PI nodes and edges
|
||||||
* @param response
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareCoPIsCountPerYearDataResponse(
|
private Map<String, String> prepareCoPIsCountPerYearDataResponse(
|
||||||
CollaborationData piNodesAndEdges) {
|
CollaborationData piNodesAndEdges) {
|
||||||
|
@ -211,8 +210,7 @@ public class CoPIGrantCountRequestHandler implements VisualizationRequestHandler
|
||||||
/**
|
/**
|
||||||
* Provides response when a csv file containing number & names of unique co-pis per
|
* Provides response when a csv file containing number & names of unique co-pis per
|
||||||
* year is requested.
|
* year is requested.
|
||||||
* @param coPIData
|
* @param coPIData Co Principal Investigator Data
|
||||||
* @param response
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareCoPIsListDataResponse(CollaborationData coPIData) {
|
private Map<String, String> prepareCoPIsListDataResponse(CollaborationData coPIData) {
|
||||||
|
|
||||||
|
@ -242,8 +240,7 @@ public class CoPIGrantCountRequestHandler implements VisualizationRequestHandler
|
||||||
/**
|
/**
|
||||||
* Provides a response when graphml formatted co-pi network is requested, typically by
|
* Provides a response when graphml formatted co-pi network is requested, typically by
|
||||||
* the flash vis.
|
* the flash vis.
|
||||||
* @param coPIData
|
* @param coPIData Co Investigator data
|
||||||
* @param response
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareNetworkStreamDataResponse(CollaborationData coPIData) {
|
private Map<String, String> prepareNetworkStreamDataResponse(CollaborationData coPIData) {
|
||||||
|
|
||||||
|
|
|
@ -69,8 +69,8 @@ public class CoPIVisCodeGenerator {
|
||||||
/**
|
/**
|
||||||
* This method is used to setup parameters for the sparkline value object. These parameters
|
* This method is used to setup parameters for the sparkline value object. These parameters
|
||||||
* will be used in the template to construct the actual html/javascript code.
|
* will be used in the template to construct the actual html/javascript code.
|
||||||
* @param visMode
|
* @param visMode Visualization mode
|
||||||
* @param visContainer
|
* @param providedVisContainerID Container ID
|
||||||
*/
|
*/
|
||||||
private SparklineData setupSparklineParameters(String visMode,
|
private SparklineData setupSparklineParameters(String visMode,
|
||||||
String providedVisContainerID) {
|
String providedVisContainerID) {
|
||||||
|
|
|
@ -199,9 +199,8 @@ public class PersonGrantCountRequestHandler implements VisualizationRequestHandl
|
||||||
/**
|
/**
|
||||||
* Provides response when csv file containing the grant count over the years
|
* Provides response when csv file containing the grant count over the years
|
||||||
* is requested.
|
* is requested.
|
||||||
* @param investigator
|
* @param investigator Investigator entiry
|
||||||
* @param yearToGrantCount
|
* @param yearToGrantCount Year / grant counts
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareDataResponse(
|
private Map<String, String> prepareDataResponse(
|
||||||
SubEntity investigator,
|
SubEntity investigator,
|
||||||
|
@ -225,9 +224,8 @@ public class PersonGrantCountRequestHandler implements VisualizationRequestHandl
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides response when an entire page dedicated to grant sparkline is requested.
|
* Provides response when an entire page dedicated to grant sparkline is requested.
|
||||||
* @param vreq
|
* @param vreq Vitro Request
|
||||||
* @param valueObjectContainer
|
* @param valueObjectContainer Sparkline data
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private TemplateResponseValues prepareStandaloneResponse(VitroRequest vreq,
|
private TemplateResponseValues prepareStandaloneResponse(VitroRequest vreq,
|
||||||
SparklineData valueObjectContainer) {
|
SparklineData valueObjectContainer) {
|
||||||
|
@ -245,10 +243,9 @@ public class PersonGrantCountRequestHandler implements VisualizationRequestHandl
|
||||||
/**
|
/**
|
||||||
* Provides response when the grant sparkline has to be rendered in already existing
|
* Provides response when the grant sparkline has to be rendered in already existing
|
||||||
* page, e.g. profile page.
|
* page, e.g. profile page.
|
||||||
* @param vreq
|
* @param vreq Vitro Request
|
||||||
* @param valueObjectContainer
|
* @param valueObjectContainer Sparkline data
|
||||||
* @param shouldVIVOrenderVis
|
* @param shouldVIVOrenderVis Flag to render visualization
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private TemplateResponseValues prepareDynamicResponse(
|
private TemplateResponseValues prepareDynamicResponse(
|
||||||
VitroRequest vreq,
|
VitroRequest vreq,
|
||||||
|
|
|
@ -60,10 +60,8 @@ public class PersonGrantCountVisCodeGenerator {
|
||||||
/**
|
/**
|
||||||
* This method is used to setup parameters for the sparkline value object. These parameters
|
* This method is used to setup parameters for the sparkline value object. These parameters
|
||||||
* will be used in the template to construct the actual html/javascript code.
|
* will be used in the template to construct the actual html/javascript code.
|
||||||
* @param visMode
|
* @param visMode Visualisation mode
|
||||||
* @param visContainer
|
* @param providedVisContainerID Container ID
|
||||||
* @param authorDocuments
|
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private SparklineData setupSparklineParameters(String visMode,
|
private SparklineData setupSparklineParameters(String visMode,
|
||||||
String providedVisContainerID) {
|
String providedVisContainerID) {
|
||||||
|
|
|
@ -217,10 +217,8 @@ VisualizationRequestHandler {
|
||||||
* Provides response when csv file containing the publication count over the
|
* Provides response when csv file containing the publication count over the
|
||||||
* years is requested.
|
* years is requested.
|
||||||
*
|
*
|
||||||
* @param author
|
* @param authorName Name of author
|
||||||
* @param authorDocuments
|
* @param yearToPublicationCount Year / publication counts
|
||||||
* @param yearToPublicationCount
|
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private Map<String, String> prepareDataResponse(String authorName,
|
private Map<String, String> prepareDataResponse(String authorName,
|
||||||
Map<String, Integer> yearToPublicationCount) {
|
Map<String, Integer> yearToPublicationCount) {
|
||||||
|
@ -251,9 +249,8 @@ VisualizationRequestHandler {
|
||||||
* Provides response when an entire page dedicated to publication sparkline
|
* Provides response when an entire page dedicated to publication sparkline
|
||||||
* is requested.
|
* is requested.
|
||||||
*
|
*
|
||||||
* @param vreq
|
* @param vreq Vitro Request
|
||||||
* @param valueObjectContainer
|
* @param valueObjectContainer Sparkline Data
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private TemplateResponseValues prepareStandaloneResponse(VitroRequest vreq,
|
private TemplateResponseValues prepareStandaloneResponse(VitroRequest vreq,
|
||||||
SparklineData valueObjectContainer) {
|
SparklineData valueObjectContainer) {
|
||||||
|
@ -272,10 +269,10 @@ VisualizationRequestHandler {
|
||||||
* Provides response when the publication sparkline has to be rendered in
|
* Provides response when the publication sparkline has to be rendered in
|
||||||
* already existing page, e.g. profile page.
|
* already existing page, e.g. profile page.
|
||||||
*
|
*
|
||||||
* @param vreq
|
* @param vreq Vitro Request
|
||||||
* @param valueObjectContainer
|
* @param valueObjectContainer Sparkline data
|
||||||
* @param yearToPublicationCount
|
* @param shouldVIVOrenderVis Flag to render visualization
|
||||||
* @return
|
* @param requestingTemplate Requesting template name
|
||||||
*/
|
*/
|
||||||
private TemplateResponseValues prepareDynamicResponse(VitroRequest vreq,
|
private TemplateResponseValues prepareDynamicResponse(VitroRequest vreq,
|
||||||
SparklineData valueObjectContainer, boolean shouldVIVOrenderVis, String requestingTemplate) {
|
SparklineData valueObjectContainer, boolean shouldVIVOrenderVis, String requestingTemplate) {
|
||||||
|
|
|
@ -62,9 +62,8 @@ public class PersonPublicationCountVisCodeGenerator {
|
||||||
/**
|
/**
|
||||||
* This method is used to setup parameters for the sparkline value object. These parameters
|
* This method is used to setup parameters for the sparkline value object. These parameters
|
||||||
* will be used in the template to construct the actual html/javascript code.
|
* will be used in the template to construct the actual html/javascript code.
|
||||||
* @param visMode
|
* @param visMode Visualization mode
|
||||||
* @param visContainer
|
* @param providedVisContainerID container id
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
private SparklineData setupSparklineParameters(String visMode,
|
private SparklineData setupSparklineParameters(String visMode,
|
||||||
String providedVisContainerID) {
|
String providedVisContainerID) {
|
||||||
|
|
|
@ -59,7 +59,6 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
* Will wait for completion if the cache is not already populated, otherwise the refresh will happen in the background.
|
* Will wait for completion if the cache is not already populated, otherwise the refresh will happen in the background.
|
||||||
*
|
*
|
||||||
* @param rdfService an RDF service to use, in foreground mode, if the background service is missing
|
* @param rdfService an RDF service to use, in foreground mode, if the background service is missing
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public synchronized T get(RDFService rdfService) {
|
public synchronized T get(RDFService rdfService) {
|
||||||
// First, check if there are results from the previous background task, and update the cache
|
// First, check if there are results from the previous background task, and update the cache
|
||||||
|
@ -171,7 +170,7 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create and start a background thread using the configured task
|
* Create and start a background thread using the configured task
|
||||||
* @param rdfService
|
* @param rdfService An RDFService
|
||||||
*/
|
*/
|
||||||
private void startBackgroundTask(RDFService rdfService) {
|
private void startBackgroundTask(RDFService rdfService) {
|
||||||
// Ensure that there isn't already a task
|
// Ensure that there isn't already a task
|
||||||
|
@ -271,7 +270,7 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the RDF service to be used for background threads (called from a startup servlet)
|
* Set the RDF service to be used for background threads (called from a startup servlet)
|
||||||
* @param rdfService
|
* @param rdfService An RDFService
|
||||||
*/
|
*/
|
||||||
public static void setBackgroundRDFService(RDFService rdfService) {
|
public static void setBackgroundRDFService(RDFService rdfService) {
|
||||||
backgroundRDFService = rdfService;
|
backgroundRDFService = rdfService;
|
||||||
|
@ -299,13 +298,13 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor that allows an affinity object to be supplied
|
* Constructor that allows an affinity object to be supplied
|
||||||
* @param affinity
|
* @param affinity Affinity
|
||||||
*/
|
*/
|
||||||
public RDFServiceCallable(Affinity affinity) { this.affinity = affinity; }
|
public RDFServiceCallable(Affinity affinity) { this.affinity = affinity; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the RDF service to be used
|
* Set the RDF service to be used
|
||||||
* @param rdfService
|
* @param rdfService An RDFService
|
||||||
*/
|
*/
|
||||||
final void setRDFService(RDFService rdfService) {
|
final void setRDFService(RDFService rdfService) {
|
||||||
this.rdfService = rdfService;
|
this.rdfService = rdfService;
|
||||||
|
@ -313,7 +312,6 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Entry point for the background threads, ensuring the right start / cleanup is done
|
* Entry point for the background threads, ensuring the right start / cleanup is done
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
@ -349,8 +347,7 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method for users to implement, to return the results
|
* Method for users to implement, to return the results
|
||||||
* @param rdfService
|
* @param rdfService An RDFService
|
||||||
* @return
|
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
protected abstract T callWithService(RDFService rdfService) throws Exception;
|
protected abstract T callWithService(RDFService rdfService) throws Exception;
|
||||||
|
@ -358,8 +355,7 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
/**
|
/**
|
||||||
* Method to determine if the cache should be invalidated for the current results
|
* Method to determine if the cache should be invalidated for the current results
|
||||||
* Default implementation dynamically adjusts the cache time based on the efficiency of creating results
|
* Default implementation dynamically adjusts the cache time based on the efficiency of creating results
|
||||||
* @param timeCached
|
* @param timeCached The time of caching
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
boolean invalidateCache(long timeCached) {
|
boolean invalidateCache(long timeCached) {
|
||||||
if (executionTime > -1) {
|
if (executionTime > -1) {
|
||||||
|
@ -416,8 +412,8 @@ public class CachingRDFServiceExecutor<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds a thread to the map, returns whether the thread needs to wait
|
* Adds a thread to the map, returns whether the thread needs to wait
|
||||||
* @param thread
|
* @param thread The thread to add
|
||||||
* @param time
|
* @param time start time of the thread
|
||||||
* @return true if the thread needs to wait, false if it can continue
|
* @return true if the thread needs to wait, false if it can continue
|
||||||
*/
|
*/
|
||||||
private synchronized boolean queueThis(Thread thread, Long time) {
|
private synchronized boolean queueThis(Thread thread, Long time) {
|
||||||
|
|
|
@ -82,7 +82,7 @@ final public class VisualizationCaches {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Rebuild the specifield caches
|
* Rebuild the specifield caches
|
||||||
* @param executors
|
* @param executors Caching RDF executors
|
||||||
*/
|
*/
|
||||||
public static void rebuild(CachingRDFServiceExecutor... executors) {
|
public static void rebuild(CachingRDFServiceExecutor... executors) {
|
||||||
if (executors != null) {
|
if (executors != null) {
|
||||||
|
|
|
@ -36,7 +36,6 @@ public class Activity extends Individual {
|
||||||
* The 2 choices, in order, are,
|
* The 2 choices, in order, are,
|
||||||
* 1. parsed year from xs:DateTime object saved in core:dateTimeValue
|
* 1. parsed year from xs:DateTime object saved in core:dateTimeValue
|
||||||
* 2. Default Publication Year
|
* 2. Default Publication Year
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public String getParsedActivityYear() {
|
public String getParsedActivityYear() {
|
||||||
|
|
||||||
|
@ -47,7 +46,6 @@ public class Activity extends Individual {
|
||||||
/**
|
/**
|
||||||
* This method should be used to get the raw date & not the parsed publication year.
|
* This method should be used to get the raw date & not the parsed publication year.
|
||||||
* For the later use getParsedPublicationYear.
|
* For the later use getParsedPublicationYear.
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public String getActivityDate() {
|
public String getActivityDate() {
|
||||||
return activityDate;
|
return activityDate;
|
||||||
|
|
|
@ -155,9 +155,9 @@ public class PDFDocument {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prints a square and fills half of it with a gray rectangle.
|
* Prints a square and fills half of it with a gray rectangle.
|
||||||
* @param x
|
* @param x X coordinate
|
||||||
* @param y
|
* @param y Y coordinate
|
||||||
* @param cb
|
* @param cb Content byte
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
public void pictureBackdrop(float x, float y, PdfContentByte cb) throws Exception {
|
public void pictureBackdrop(float x, float y, PdfContentByte cb) throws Exception {
|
||||||
|
@ -172,9 +172,9 @@ public class PDFDocument {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prints 3 circles in different colors that intersect with eachother.
|
* Prints 3 circles in different colors that intersect with eachother.
|
||||||
* @param x
|
* @param x X coordinate
|
||||||
* @param y
|
* @param y Y coordinate
|
||||||
* @param cb
|
* @param cb Content byte
|
||||||
* @throws Exception
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
public void pictureCircles(float x, float y, PdfContentByte cb) throws Exception {
|
public void pictureCircles(float x, float y, PdfContentByte cb) throws Exception {
|
||||||
|
|
|
@ -77,8 +77,7 @@ public class UtilityFunctions {
|
||||||
/**
|
/**
|
||||||
* This method is used to return a mapping between activity year & all the collaborators
|
* This method is used to return a mapping between activity year & all the collaborators
|
||||||
* that published with ego in that year.
|
* that published with ego in that year.
|
||||||
* @param collaborationData
|
* @param collaborationData Collaboration data
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public static Map<String, Set<Collaborator>> getActivityYearToCollaborators(
|
public static Map<String, Set<Collaborator>> getActivityYearToCollaborators(
|
||||||
CollaborationData collaborationData) {
|
CollaborationData collaborationData) {
|
||||||
|
@ -121,8 +120,7 @@ public class UtilityFunctions {
|
||||||
/**
|
/**
|
||||||
* Currently the approach for slugifying filenames is naive. In future if there is need,
|
* Currently the approach for slugifying filenames is naive. In future if there is need,
|
||||||
* we can write more sophisticated method.
|
* we can write more sophisticated method.
|
||||||
* @param textToBeSlugified
|
* @param textToBeSlugified Text to process
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public static String slugify(String textToBeSlugified) {
|
public static String slugify(String textToBeSlugified) {
|
||||||
String textBlockSeparator = "-";
|
String textBlockSeparator = "-";
|
||||||
|
@ -186,7 +184,6 @@ public class UtilityFunctions {
|
||||||
* The 2 choices, in order, are,
|
* The 2 choices, in order, are,
|
||||||
* 1. parsed year from core:DateTime object saved in core:dateTimeValue
|
* 1. parsed year from core:DateTime object saved in core:dateTimeValue
|
||||||
* 2. Default Entity Year
|
* 2. Default Entity Year
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public static String getValidYearFromCoreDateTimeString(String inputDate,
|
public static String getValidYearFromCoreDateTimeString(String inputDate,
|
||||||
String defaultYearInCaseOfError) {
|
String defaultYearInCaseOfError) {
|
||||||
|
@ -279,9 +276,8 @@ public class UtilityFunctions {
|
||||||
*
|
*
|
||||||
* This method will test whether the current uri is based off of default namespace. If so,
|
* This method will test whether the current uri is based off of default namespace. If so,
|
||||||
* go ahead & provide local name.
|
* go ahead & provide local name.
|
||||||
* @param givenURI
|
* @param givenURI URI
|
||||||
* @param vitroRequest
|
* @param vitroRequest Vitro Request
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public static String getIndividualLocalName(String givenURI, VitroRequest vitroRequest) {
|
public static String getIndividualLocalName(String givenURI, VitroRequest vitroRequest) {
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue