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

Clean up list view config documentation.

Browse source
This commit is contained in:
rjy7 2011-01-05 20:05:28 +00:00
parent 25a818efa9
commit 54e6941282
3 changed files with 11 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/list_view_configuration_guidelines.txt
View file

@ -15,7 +15,8 @@ Optional elements
----------------- -----------------
- postprocessor: a Java class that postprocesses the data retrieved from the query before - postprocessor: a Java class that postprocesses the data retrieved from the query before
sending it to the template sending it to the template. If no postprocessor is specified, the default
postprocessor will be invoked.
------------------ ------------------
@ -27,12 +28,13 @@ the same individual is retrieved more than once, if there are multiple solutions
other assertions, but DISTINCT provides a start at uniqueness. other assertions, but DISTINCT provides a start at uniqueness.
- The WHERE clause must contain a statement ?subject ?property ?object, with the variables - The WHERE clause must contain a statement ?subject ?property ?object, with the variables
?subject and ?property named as such. The object can be given any name, but it must be ?subject and ?property named as such. For a default list view, the ?object variable must
also be named as such. For a custom list view, the object can be given any name, but it must be
included in the SELECT terms retrieved by the query. This is the statement that will be edited included in the SELECT terms retrieved by the query. This is the statement that will be edited
from the edit links. from the edit links.
- It is generally necessary to provide for a missing linked individual, due to incomplete data. - In a custom list view, it is generally necessary to provide for a missing linked individual,
Make sure the query does the following: due to the possibility of incomplete data. Make sure the query does the following:
- Enclose the clause for the linked individual in an OPTIONAL block. - Enclose the clause for the linked individual in an OPTIONAL block.
- Select the object's localname using the ARQ localname function, so that the template can - Select the object's localname using the ARQ localname function, so that the template can
display the local name in the absence of the linked individual. Alternatively, this can be display the local name in the absence of the linked individual. Alternatively, this can be
@ -43,7 +45,7 @@ no requirement about which assertions are in the same graph is imposed (unless t
in a specific case). in a specific case).
- For collated properties: - For collated properties:
- Include a ?subclass variable, named as such, in the SELECT claus. If the ?subclass variable - Include a ?subclass variable, named as such, in the SELECT clause. If the ?subclass variable
is missing, the property will be displayed without collation. is missing, the property will be displayed without collation.
- ?subclass must be the first term in the ORDER BY clause - ?subclass must be the first term in the ORDER BY clause
- Include the following in the WHERE clause, substituting in the relevant variables for - Include the following in the WHERE clause, substituting in the relevant variables for

20
webapp/web/config/listViewConfig-default-collated.xml
View file

@ -1,25 +1,9 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $This file is distributed under the terms of the license in /doc/license.txt$ --> <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
<!-- <!-- Default list view config file for collated object properties
Default list view config file for collated object properties
Required elements:
- query: the sparql query used to retrieve the data
- template: the name of the template used to display a single property statement
Optional elements: See guidelines in vitro/doc/list_view_configuration_guidelines.txt -->
- postprocessor: a Java class that postprocesses the data retrieved from the query before
sending it to the template
Query requirements:
- WHERE clause must contain a statement ?subject ?property ?object, with the variables
?subject and ?property named as such. The object can be given any name, but it must be
included in the SELECT terms retrieved by the query. This is the statement that will be edited
from the edit links.
- Each assertion or set of optional assertions must reference a different graph variable, so that
we do not impose a requirement about which assertions are in the same graph.
-->
<list-view-config> <list-view-config>
<query> <query>

20
webapp/web/config/listViewConfig-default-uncollated.xml
View file

@ -1,25 +1,9 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!-- $This file is distributed under the terms of the license in /doc/license.txt$ --> <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
<!-- <!-- Default list view config file for uncollated object properties
Default list view config file for uncollated object properties
Required elements: See guidelines in vitro/doc/list_view_configuration_guidelines.txt -->
- query: the sparql query used to retrieve the data
- template: the name of the template used to display a single property statement
Optional elements:
- postprocessor: a Java class that postprocesses the data retrieved from the query before
sending it to the template
Query requirements:
- WHERE clause must contain a statement ?subject ?property ?object, with the variables
?subject and ?property named as such. The object can be given any name, but it must be
included in the SELECT terms retrieved by the query. This is the statement that will be edited
from the edit links.
- Each assertion or set of optional assertions must reference a different graph variable, so that
we do not impose a requirement about which assertions are in the same graph.
-->
<list-view-config> <list-view-config>
<query> <query>