edu.cornell.mannlib.vitro.webapp.edit.n3editing.VTwo

Class EditConfigurationVTwo

java.lang.Object

edu.cornell.mannlib.vitro.webapp.edit.n3editing.VTwo.EditConfigurationVTwo

public class EditConfigurationVTwo
extends Object

Represents a set of fields on a form and how parameters from a from submission should be manipulated to create N3. Uris in urisInScope and urisOnForm should not have any quoting or escaping. Literals in literalsOnForm and literalsInScope should be escaped and quoted in preparation for N3. They may also be appended with a datatype or lang.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isParamUpdate
static String	USE_SYSTEM_VALUE

Constructor Summary

Constructors

Constructor and Description
EditConfigurationVTwo()

Method Summary

Modifier and Type	Method and Description
void	addEditSubmissionPreprocessor(EditSubmissionVTwoPreprocessor preprocessor)
void	addField(FieldVTwo field)
void	addFields(List<FieldVTwo> fields)
void	addFormSpecificData(String key, Object value)
EditConfigurationVTwo	addLiteralInScope(String key, com.hp.hpl.jena.rdf.model.Literal... values)
EditConfigurationVTwo	addLiteralsInScope(Map<String,List<com.hp.hpl.jena.rdf.model.Literal>> scopeLiterals)
void	addLiteralsOnForm(List<String> literalsOnForm)
void	addLiteralsOnForm(String... strs)
void	addModelChangePreprocessor(ModelChangePreprocessor modelChangePreprocessor)
void	addN3Optional(List<String> n3Optional)
void	addN3Optional(String... n3Strs)
void	addN3Required(List<String> n3RequiredInput)
void	addN3Required(String... n3RequiredStrsInput)
void	addNewResource(String key, String namespace)
void	addSparqlForAdditionalLiteralsInScope(String key, String sparql)
void	addSparqlForAdditionalUrisInScope(String key, String sparql)
void	addSparqlForExistingLiteral(String key, String sparql)
void	addSparqlForExistingUris(String key, String sparql)
void	addSystemValues(com.hp.hpl.jena.rdf.model.Model model, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context) Add symbols for things like currentTime and editingUser to editConfig.urisInScope and editConfig.literalsInScope.
EditConfigurationVTwo	addUrisInScope(Map<String,List<String>> uriValues)
EditConfigurationVTwo	addUrisInScope(String key, List<String> list)
void	addUrisOnForm(List<String> urisOnform)
void	addUrisOnForm(String... strs)
void	addValidator(N3ValidatorVTwo validator)
protected void	basicPrepare()
static void	clearAllConfigsInSession(javax.servlet.http.HttpSession sess)
static void	clearEditConfigurationInSession(javax.servlet.http.HttpSession session, EditConfigurationVTwo editConfig)
EditConfigurationVTwo	copy()
String	getAboxModelId()
static EditConfigurationVTwo	getConfigFromSession(javax.servlet.http.HttpSession sess, javax.servlet.http.HttpServletRequest request) This may return null, which indicates that there is no editKey or EditConfiguration in the request or session.
static EditConfigurationVTwo	getConfigFromSession(javax.servlet.http.HttpSession sess, String editKey)
Integer	getDatapropKey()
String	getEditKey()
static String	getEditKeyFromRequest(javax.servlet.ServletRequest request) The editKey can be a HTTP query parameter or it can be a request attribute.
List<EditSubmissionVTwoPreprocessor>	getEditSubmissionPreprocessors()
String	getEntityToReturnTo()
FieldVTwo	getField(String key)
Map<String,FieldVTwo>	getFields()
List<String>	getFilesOnForm()
HashMap<String,Object>	getFormSpecificData()
String	getFormUrl()
Map<String,List<com.hp.hpl.jena.rdf.model.Literal>>	getLiteralsInScope()
List<String>	getLiteralsOnForm()
List<ModelChangePreprocessor>	getModelChangePreprocessors()
EditN3GeneratorVTwo	getN3Generator()
List<String>	getN3Optional() return a copy of the value so that the configuration is not modified by external code.
List<String>	getN3Required() Return a copy of the value so that the configuration is not modified by external code.
Map<String,String>	getNewResources()
String	getObject()
String	getPredicateUri()
ProhibitedFromSearch	getProhibitedFromSearch()
ModelSelector	getQueryModelSelector()
ModelSelector	getResourceModelSelector()
String	getSkipToUrl()
Map<String,String>	getSparqlForAdditionalLiteralsInScope() Return a copy of the value so that the configuration is not modified by external code.
Map<String,String>	getSparqlForAdditionalUrisInScope() Return a copy of the value so that the configuration is not modified by external code.
Map<String,String>	getSparqlForExistingLiterals() return a copy of the value so that the configuration is not modified by external code.
Map<String,String>	getSparqlForExistingUris() return a copy of the value so that the configuration is not modified by external code.
String	getSubjectUri()
String	getSubmitToUrl()
String	getTboxModelId()
String	getTemplate()
Map<String,List<String>>	getUrisInScope()
List<String>	getUrisOnform()
String	getUrlPatternToReturnTo()
String	getUrlToReturnTo()
List<N3ValidatorVTwo>	getValidators()
String	getVarNameForObject()
String	getVarNameForPredicate()
String	getVarNameForSubject()
WDFSelector	getWdfSelectorForOptons()
String	getWriteModelId()
ModelSelector	getWriteModelSelector()
boolean	hasBeenPreparedForUpdate()
boolean	isDataPropertyUpdate()
boolean	isObjectPropertyUpdate()
boolean	isObjectResource()
boolean	isParamUpdate()
boolean	isUpdate()
boolean	isUseDependentResourceDelete() If this is set to true, then dependent resources should be deleted on edits that remove the parent resource.
static String	newEditKey(javax.servlet.http.HttpSession sess)
void	prepareForDataPropUpdate(com.hp.hpl.jena.rdf.model.Model model, DataPropertyDao dataPropertyDao) Prepare an EditConfiguration for a DataProperty update.
void	prepareForNonUpdate(com.hp.hpl.jena.rdf.model.Model model) Run SPARQL for Additional values.
void	prepareForObjPropUpdate(com.hp.hpl.jena.rdf.model.Model model) Prepare for a ObjectProperty update.
void	prepareForParamUpdate(com.hp.hpl.jena.rdf.model.Model model) Prepare for a param update: Run SPARQL for existing values.
void	prepareForResubmit(MultiValueEditSubmission editSub)
static void	putConfigInSession(EditConfigurationVTwo ec, javax.servlet.http.HttpSession sess)
void	runSparqlForAdditional(SparqlEvaluateVTwo sparqlEval) Runs the queries for additional uris and literals then add those back into the urisInScope and literalsInScope.
void	runSparqlForExisting(SparqlEvaluateVTwo sparqlEval)
void	setAboxModelId(String aboxModelId)
void	setDatapropKey(Integer datapropKey)
void	setEditKey(String editKey)
void	setEntityToReturnTo(String entityToReturnTo)
void	setFields(Map<String,FieldVTwo> fields)
void	setFilesOnForm(List<String> filesOnForm)
void	setFormSpecificData(HashMap<String,Object> formSpecificData) This is for specific data for a form that will be set by the generator.
void	setFormUrl(String formUrl)
void	setLiteralsInScope(Map<String,List<com.hp.hpl.jena.rdf.model.Literal>> literalsInScope)
void	setLiteralsOnForm(List<String> literalsOnForm)
void	setLiteralsOnForm(String... strs)
void	setN3Generator(EditN3GeneratorVTwo gen)
void	setN3Optional(List<String> n3Optional)
void	setN3Optional(String... n3Strs)
void	setN3Required(List<String> n3Required)
void	setN3Required(String... n3RequiredStrs)
void	setNewResources(Map<String,String> newResources)
void	setNewResources(String... strs)
void	setObject(String object)
void	setParamUpdate(boolean inputParamUpdate)
void	setPredicateUri(String predicateUri)
void	setProhibitedFromSearch(ProhibitedFromSearch prohibitedFromSearch)
void	setQueryModelSelector(ModelSelector queryModel)
void	setResourceModelSelector(ModelSelector resourceModelSelector)
void	setSkipToUrl(String url)
void	setSparqlForAdditionalLiteralsInScope(Map<String,String> sparqlForAdditionalLiteralsInScope)
void	setSparqlForAdditionalUrisInScope(Map<String,String> sparqlForAdditionalUrisInScope)
void	setSparqlForExistingLiterals(Map<String,String> sparqlForExistingLiterals)
void	setSparqlForExistingUris(Map<String,String> sparqlForExistingUris)
void	setSubjectUri(String subjectUri)
void	setSubmitToUrl(String submitToUrl)
void	setTboxModelId(String tboxModelId)
void	setTemplate(String template)
void	setUrisInScope(Map<String,List<String>> urisInScope)
void	setUrisOnform(List<String> urisOnform)
void	setUrisOnForm(String... strs)
void	setUrlPatternToReturnTo(String s)
void	setUrlToReturnTo(String url)
void	setUseDependentResourceDelete(boolean useDependentResourceDelete) If this is set to true, then dependent resources should be deleted on edits that remove the parent resource.
void	setVarNameForObject(String varName)
void	setVarNameForPredicate(String varName)
void	setVarNameForSubject(String varName)
void	setWdfSelectorForOptons(WDFSelector wdfForOptons)
void	setWriteModelId(String writeModelId)
void	setWriteModelSelector(ModelSelector writeModel)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

USE_SYSTEM_VALUE

public static final String USE_SYSTEM_VALUE

See Also:

Constant Field Values

isParamUpdate

public boolean isParamUpdate

Constructor Detail

EditConfigurationVTwo

public EditConfigurationVTwo()

Method Detail

copy

public EditConfigurationVTwo copy()

addSystemValues

public void addSystemValues(com.hp.hpl.jena.rdf.model.Model model,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.ServletContext context)

Add symbols for things like currentTime and editingUser to editConfig.urisInScope and editConfig.literalsInScope.

basicPrepare

protected void basicPrepare()

prepareForDataPropUpdate

public void prepareForDataPropUpdate(com.hp.hpl.jena.rdf.model.Model model,
                                     DataPropertyDao dataPropertyDao)

Prepare an EditConfiguration for a DataProperty update. This should only be used when editing a existing data property statement.

prepareForObjPropUpdate

public void prepareForObjPropUpdate(com.hp.hpl.jena.rdf.model.Model model)

Prepare for a ObjectProperty update. Run SPARQL for existing values. This can be used for an object property or a direct form.

prepareForParamUpdate

public void prepareForParamUpdate(com.hp.hpl.jena.rdf.model.Model model)

Prepare for a param update: Run SPARQL for existing values. This can be used for a direct form which does not correspond directly to either data or object property form.

prepareForNonUpdate

public void prepareForNonUpdate(com.hp.hpl.jena.rdf.model.Model model)

Run SPARQL for Additional values. This can be used for a data property, an object property or a direct form.

setFields

public void setFields(Map<String,FieldVTwo> fields)

prepareForResubmit

public void prepareForResubmit(MultiValueEditSubmission editSub)

runSparqlForAdditional

public void runSparqlForAdditional(SparqlEvaluateVTwo sparqlEval)

Runs the queries for additional uris and literals then add those back into the urisInScope and literalsInScope.

runSparqlForExisting

public void runSparqlForExisting(SparqlEvaluateVTwo sparqlEval)

getField

public FieldVTwo getField(String key)

getN3Required

public List<String> getN3Required()

Return a copy of the value so that the configuration is not modified by external code.

setN3Required

public void setN3Required(List<String> n3Required)

setN3Required

public void setN3Required(String... n3RequiredStrs)

addN3Required

public void addN3Required(List<String> n3RequiredInput)

addN3Required

public void addN3Required(String... n3RequiredStrsInput)

getN3Optional

public List<String> getN3Optional()

return a copy of the value so that the configuration is not modified by external code.

setN3Optional

public void setN3Optional(List<String> n3Optional)

setN3Optional

public void setN3Optional(String... n3Strs)

addN3Optional

public void addN3Optional(List<String> n3Optional)

addN3Optional

public void addN3Optional(String... n3Strs)

getNewResources

public Map<String,String> getNewResources()

setNewResources

public void setNewResources(Map<String,String> newResources)

setNewResources

public void setNewResources(String... strs)

getUrisOnform

public List<String> getUrisOnform()

setUrisOnform

public void setUrisOnform(List<String> urisOnform)

setUrisOnForm

public void setUrisOnForm(String... strs)

addUrisOnForm

public void addUrisOnForm(List<String> urisOnform)

addUrisOnForm

public void addUrisOnForm(String... strs)

setFilesOnForm

public void setFilesOnForm(List<String> filesOnForm)

getFilesOnForm

public List<String> getFilesOnForm()

getLiteralsOnForm

public List<String> getLiteralsOnForm()

setLiteralsOnForm

public void setLiteralsOnForm(List<String> literalsOnForm)

setLiteralsOnForm

public void setLiteralsOnForm(String... strs)

addLiteralsOnForm

public void addLiteralsOnForm(List<String> literalsOnForm)

addLiteralsOnForm

public void addLiteralsOnForm(String... strs)

getUrisInScope

public Map<String,List<String>> getUrisInScope()

setUrisInScope

public void setUrisInScope(Map<String,List<String>> urisInScope)

addUrisInScope

public EditConfigurationVTwo addUrisInScope(String key,
                                            List<String> list)

addUrisInScope

public EditConfigurationVTwo addUrisInScope(Map<String,List<String>> uriValues)

getLiteralsInScope

public Map<String,List<com.hp.hpl.jena.rdf.model.Literal>> getLiteralsInScope()

setLiteralsInScope

public void setLiteralsInScope(Map<String,List<com.hp.hpl.jena.rdf.model.Literal>> literalsInScope)

getSparqlForAdditionalUrisInScope

public Map<String,String> getSparqlForAdditionalUrisInScope()

Return a copy of the value so that the configuration is not modified by external code.

setSparqlForAdditionalUrisInScope

public void setSparqlForAdditionalUrisInScope(Map<String,String> sparqlForAdditionalUrisInScope)

getSparqlForAdditionalLiteralsInScope

public Map<String,String> getSparqlForAdditionalLiteralsInScope()

Return a copy of the value so that the configuration is not modified by external code.

setSparqlForAdditionalLiteralsInScope

public void setSparqlForAdditionalLiteralsInScope(Map<String,String> sparqlForAdditionalLiteralsInScope)

getEntityToReturnTo

public String getEntityToReturnTo()

setEntityToReturnTo

public void setEntityToReturnTo(String entityToReturnTo)

getUrlPatternToReturnTo

public String getUrlPatternToReturnTo()

setUrlPatternToReturnTo

public void setUrlPatternToReturnTo(String s)

getSparqlForExistingLiterals

public Map<String,String> getSparqlForExistingLiterals()

return a copy of the value so that the configuration is not modified by external code.

setSparqlForExistingLiterals

public void setSparqlForExistingLiterals(Map<String,String> sparqlForExistingLiterals)

getSparqlForExistingUris

public Map<String,String> getSparqlForExistingUris()

return a copy of the value so that the configuration is not modified by external code.

setSparqlForExistingUris

public void setSparqlForExistingUris(Map<String,String> sparqlForExistingUris)

clearAllConfigsInSession

public static void clearAllConfigsInSession(javax.servlet.http.HttpSession sess)

clearEditConfigurationInSession

public static void clearEditConfigurationInSession(javax.servlet.http.HttpSession session,
                                                   EditConfigurationVTwo editConfig)

putConfigInSession

public static void putConfigInSession(EditConfigurationVTwo ec,
                                      javax.servlet.http.HttpSession sess)

getConfigFromSession

public static EditConfigurationVTwo getConfigFromSession(javax.servlet.http.HttpSession sess,
                                                         String editKey)

getConfigFromSession

public static EditConfigurationVTwo getConfigFromSession(javax.servlet.http.HttpSession sess,
                                                         javax.servlet.http.HttpServletRequest request)

This may return null, which indicates that there is no editKey or EditConfiguration in the request or session. If the queryParams are supplied, look for the editKey there first since multipart parsing might have cleared them from the request.

getEditKeyFromRequest

public static String getEditKeyFromRequest(javax.servlet.ServletRequest request)

The editKey can be a HTTP query parameter or it can be a request attribute.

newEditKey

public static String newEditKey(javax.servlet.http.HttpSession sess)

getObject

public String getObject()

setObject

public void setObject(String object)

isObjectResource

public boolean isObjectResource()

getDatapropKey

public Integer getDatapropKey()

setDatapropKey

public void setDatapropKey(Integer datapropKey)

getSubjectUri

public String getSubjectUri()

setSubjectUri

public void setSubjectUri(String subjectUri)

getPredicateUri

public String getPredicateUri()

setPredicateUri

public void setPredicateUri(String predicateUri)

getFields

public Map<String,FieldVTwo> getFields()

getEditKey

public String getEditKey()

setEditKey

public void setEditKey(String editKey)

getFormUrl

public String getFormUrl()

setFormUrl

public void setFormUrl(String formUrl)

getN3Generator

public EditN3GeneratorVTwo getN3Generator()

setN3Generator

public void setN3Generator(EditN3GeneratorVTwo gen)

getVarNameForSubject

public String getVarNameForSubject()

setVarNameForSubject

public void setVarNameForSubject(String varName)

getVarNameForPredicate

public String getVarNameForPredicate()

setVarNameForPredicate

public void setVarNameForPredicate(String varName)

getVarNameForObject

public String getVarNameForObject()

setVarNameForObject

public void setVarNameForObject(String varName)

isUseDependentResourceDelete

public boolean isUseDependentResourceDelete()

If this is set to true, then dependent resources should be deleted on edits that remove the parent resource.

setUseDependentResourceDelete

public void setUseDependentResourceDelete(boolean useDependentResourceDelete)

If this is set to true, then dependent resources should be deleted on edits that remove the parent resource.

getModelChangePreprocessors

public List<ModelChangePreprocessor> getModelChangePreprocessors()

addModelChangePreprocessor

public void addModelChangePreprocessor(ModelChangePreprocessor modelChangePreprocessor)

setProhibitedFromSearch

public void setProhibitedFromSearch(ProhibitedFromSearch prohibitedFromSearch)

getProhibitedFromSearch

public ProhibitedFromSearch getProhibitedFromSearch()

getWriteModelSelector

public ModelSelector getWriteModelSelector()

setWriteModelSelector

public void setWriteModelSelector(ModelSelector writeModel)

getQueryModelSelector

public ModelSelector getQueryModelSelector()

setQueryModelSelector

public void setQueryModelSelector(ModelSelector queryModel)

getWdfSelectorForOptons

public WDFSelector getWdfSelectorForOptons()

setWdfSelectorForOptons

public void setWdfSelectorForOptons(WDFSelector wdfForOptons)

getResourceModelSelector

public ModelSelector getResourceModelSelector()

setResourceModelSelector

public void setResourceModelSelector(ModelSelector resourceModelSelector)

getValidators

public List<N3ValidatorVTwo> getValidators()

addValidator

public void addValidator(N3ValidatorVTwo validator)

addEditSubmissionPreprocessor

public void addEditSubmissionPreprocessor(EditSubmissionVTwoPreprocessor preprocessor)

getEditSubmissionPreprocessors

public List<EditSubmissionVTwoPreprocessor> getEditSubmissionPreprocessors()

setTemplate

public void setTemplate(String template)

getTemplate

public String getTemplate()

getSubmitToUrl

public String getSubmitToUrl()

setSubmitToUrl

public void setSubmitToUrl(String submitToUrl)

isUpdate

public boolean isUpdate()

isObjectPropertyUpdate

public boolean isObjectPropertyUpdate()

isDataPropertyUpdate

public boolean isDataPropertyUpdate()

setParamUpdate

public void setParamUpdate(boolean inputParamUpdate)

isParamUpdate

public boolean isParamUpdate()

setFormSpecificData

public void setFormSpecificData(HashMap<String,Object> formSpecificData)

This is for specific data for a form that will be set by the generator.

addFormSpecificData

public void addFormSpecificData(String key,
                                Object value)

getFormSpecificData

public HashMap<String,Object> getFormSpecificData()

hasBeenPreparedForUpdate

public boolean hasBeenPreparedForUpdate()

addNewResource

public void addNewResource(String key,
                           String namespace)

addSparqlForExistingLiteral

public void addSparqlForExistingLiteral(String key,
                                        String sparql)

addSparqlForExistingUris

public void addSparqlForExistingUris(String key,
                                     String sparql)

addSparqlForAdditionalLiteralsInScope

public void addSparqlForAdditionalLiteralsInScope(String key,
                                                  String sparql)

addSparqlForAdditionalUrisInScope

public void addSparqlForAdditionalUrisInScope(String key,
                                              String sparql)

addField

public void addField(FieldVTwo field)

addFields

public void addFields(List<FieldVTwo> fields)

toString

public String toString()

Overrides:

toString in class Object

addLiteralInScope

public EditConfigurationVTwo addLiteralInScope(String key,
                                               com.hp.hpl.jena.rdf.model.Literal... values)

addLiteralsInScope

public EditConfigurationVTwo addLiteralsInScope(Map<String,List<com.hp.hpl.jena.rdf.model.Literal>> scopeLiterals)

setUrlToReturnTo

public void setUrlToReturnTo(String url)

getUrlToReturnTo

public String getUrlToReturnTo()

setSkipToUrl

public void setSkipToUrl(String url)

getSkipToUrl

public String getSkipToUrl()

setWriteModelId

public void setWriteModelId(String writeModelId)

getWriteModelId

public String getWriteModelId()

setAboxModelId

public void setAboxModelId(String aboxModelId)

getAboxModelId

public String getAboxModelId()

setTboxModelId

public void setTboxModelId(String tboxModelId)

getTboxModelId

public String getTboxModelId()