org.cogchar.lifter.generation.PageGeneratorUtils Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2013 by The Cogchar Project (www.cogchar.org).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.cogchar.lifter.generation;
import com.hp.hpl.jena.rdf.model.Model;
import com.hp.hpl.jena.rdf.model.ModelFactory;
import com.hp.hpl.jena.rdf.model.Property;
import java.util.Map;
import org.appdapter.core.name.Ident;
import com.hp.hpl.jena.rdf.model.Resource;
import org.appdapter.core.name.FreeIdent;
import org.cogchar.name.goody.GoodyNames;
import org.cogchar.name.lifter.LiftAN;
import org.cogchar.name.thing.ThingCN;
/**
* This class provides a mechanism for dynamically generating lifter pages for
* a question-response scenario.
*
* @author Jason Randolph Eads
*/
public class PageGeneratorUtils {
/**
* Generates a page and stores it in the local repo.
*
* @param lifterConfigID ID of the page to be generated
* @param answerLabelsAndAction button label => button action
*/
public static Model make12SlotLifterPageWithPushyButtons(
Ident lifterConfigID,
Map controlDescriptions) {
// The RDF container
Model dataModel = ModelFactory.createDefaultModel();
// Generate lifterConfig RDF idividial, which represents the lifter page
generate12SlotLifterConfig( dataModel, lifterConfigID );
// Generate the button for each response
for( Integer key : controlDescriptions.keySet() ) {
LifterControlDescription desc = controlDescriptions.get(key);
generatePushyButtonControlForQuestion(
dataModel,
lifterConfigID,
key,
desc.label,
desc.color,
desc.image,
desc.action);
}
return dataModel;
}
/**
* Collection of values to describe a button that should be generated
*/
public static class LifterControlDescription {
public static enum descriptionElement {
BUTTON_COLOR,
BUTTON_IMAGE,
BUTTON_LABEL,
BUTTON_ACTION };
public String color = null;
public String image = null;
public String label = null;
public Ident action = null;
}
public static Model makeThingActionTriggerForLifterPage(
Ident liftConfigID) {
// The RDF container
Model dataModel = ModelFactory.createDefaultModel();
// Derive name for new ThingAction
String thingActionName = liftConfigID.getAbsUriString() +
"_Trigger_ThingAction";
Ident thingActionID = new FreeIdent(thingActionName);
// Derive Param name
String thingActionParamName = liftConfigID.getAbsUriString() +
"_Trigger_ThingActionParam1";
Ident thinActionParamID = new FreeIdent(thingActionParamName);
// Generate the ThingActionParam that carries the payload
generateThingActionTriggerForLifterParam(
dataModel,
liftConfigID,
thinActionParamID);
// Generate the base ThingAction
generateThingActionTriggerForLifter(
dataModel,
thingActionID,
thinActionParamID);
// Return the Model containing the trigger
return dataModel;
}
// *** private members ***
/**
*
* @param dataModel
* @param liftConfigID
* @param thingActionParamID
*/
private static void generateThingActionTriggerForLifterParam(
Model dataModel,
Ident liftConfigID,
Ident thingActionParamID) {
// Generate ThingAction individual
String taParamIDString = thingActionParamID.getAbsUriString();
Resource taParamResource = dataModel.createResource(taParamIDString);
// Define the RDF type to be ThingActionParam
Property rdfTypeProp = dataModel.createProperty(
GoodyNames.RDF_TYPE.getAbsUriString());
taParamResource.addProperty(
rdfTypeProp,
ThingCN.T_ThingActionParam);
// Define the parameters's key (paramIdent)
Property paramKeyProp = dataModel.createProperty(
ThingCN.P_paramIdent);
taParamResource.addProperty(
paramKeyProp,
lifterActionID.getAbsUriString());
// Define the parameters's value (paramIdentValue)
Property paramValueProp = dataModel.createProperty(
ThingCN.P_paramIdentValue);
taParamResource.addProperty(
paramValueProp,
liftConfigID.getAbsUriString());
// The Model now contains the TA Parameter which specifies the lift page
}
//TODO: FIX THIS. This is a namespace problem.
private final static Ident lifterActionID = null;
private static void generateThingActionTriggerForLifter(
Model dataModel,
Ident thingActionID,
Ident thingActionParamID) {
// Generate ThingAction individual
String taIDString = thingActionID.getAbsUriString();
Resource taResource = dataModel.createResource(taIDString);
// Defines the RDF type to be that of a ThingAction
Property rdfTypeProp = dataModel.createProperty(
GoodyNames.RDF_TYPE.getAbsUriString());
taResource.addProperty(
rdfTypeProp,
ThingCN.T_ThingAction);
// Defines the TA's verb as the TA itself
// ( currently a verb is required by the query system for a valid TA )
Property verbProp = dataModel.createProperty(
ThingCN.P_verb);
taResource.addProperty(
verbProp,
thingActionID.getAbsUriString());
// Defines the TA's targetThing as the TA itself
// ( currently a target is required by the query system for a valid TA )
Property targetThingProp = dataModel.createProperty(
ThingCN.P_targetThing);
taResource.addProperty(
targetThingProp,
thingActionID.getAbsUriString());
// Defines the TA's targetThing as the TA itself
// ( currently a target is required by the query system for a valid TA )
Property targetThingTypeProp = dataModel.createProperty(
ThingCN.P_targetThingType);
taResource.addProperty(
targetThingTypeProp,
ThingCN.T_ThingAction);
// Declares the TA's creation-time in a timestamp
Property timestampProp = dataModel.createProperty(
ThingCN.P_postedTSMsec);
taResource.addProperty(
timestampProp,
Long.toString(System.currentTimeMillis()));
//TODO: FIX THIS MESS, the values used in the system are inverted...
// This declares the targetAction ... as the param....
// This is interpreted as a reference to the param, not the param's action
// The namespace needs to change, not the code
Property targetActionProp = dataModel.createProperty(
ThingCN.P_IdentAttachedToThingAction);
taResource.addProperty(
targetActionProp,
thingActionParamID.getAbsUriString());
// The Model now contains the ThingAction.
}
private static void generate12SlotLifterConfig(
Model dataModel,
Ident lifterConfigID) {
// Generate lifterConfig idividial
Resource lifterConfigResource = dataModel.createResource(
lifterConfigID.getAbsUriString());
// Defines the RDF type to be that of a liftConfig page definition
Property rdfType = dataModel.createProperty(
GoodyNames.RDF_TYPE.getAbsUriString());
lifterConfigResource.addProperty(
rdfType,
LiftAN.NS_LifterConfig);
// Sets the page template to be used by the page
Property pageTemplate = dataModel.createProperty(LiftAN.P_template);
lifterConfigResource.addProperty(
pageTemplate,
"12slots");
}
private static void generatePushyButtonControlForQuestion(
Model dataModel,
Ident lifterConfigID,
Integer controlCount,
String label,
String color,
String image,
Ident thingAction) {
// Generate control individual
String controlIDString =
lifterConfigID.getAbsUriString() +
"_control_" +
controlCount.toString();
Resource controlResource = dataModel.createResource(controlIDString);
// Defines the RDF type to be that of a liftcontrol
Property rdfType = dataModel.createProperty(
GoodyNames.RDF_TYPE.getAbsUriString());
controlResource.addProperty(
rdfType,
"liftcontrol"); //TODO: <- EXPAND URI!
// Attach the control to its parent page
Property parentConfig = dataModel.createProperty(
LiftAN.P_liftConfig);
controlResource.addProperty(
parentConfig,
lifterConfigID.getAbsUriString());
// Define the control type to use
Property controlType = dataModel.createProperty(
LiftAN.P_controlType);
controlResource.addProperty(
controlType,
"PUSHYBUTTON");
// set the button's label
if(label != null && !label.isEmpty()) {
Property buttonLabelText = dataModel.createProperty(
LiftAN.P_controlText);
controlResource.addProperty(
buttonLabelText,
label);
}
//TODO: type checking on color
// set the style element (the color) of the button
if(color != null && !color.isEmpty()) {
Property buttonStyle = dataModel.createProperty(
LiftAN.P_controlStyle);
controlResource.addProperty(
buttonStyle,
color);
}
// set the buttons resource (the image)
if(image != null && !image.isEmpty()) {
Property buttonResource = dataModel.createProperty(
LiftAN.P_controlResource);
controlResource.addProperty(
buttonResource,
image);
}
// set the buttons action
if(thingAction != null) {
Property buttonAction = dataModel.createProperty(
LiftAN.P_controlAction);
controlResource.addProperty(
buttonAction,
thingAction.getAbsUriString());
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy