Hanami properties
To ease configuration, the Hanami ontology introduces some properties to configure the UI and how the data should be validated.
These are listed below, grouped by their domain classes.
Properties on sh:Shape and subclasses
Data properties
| property | domain | datatype | description |
|---|
| hanami:isRoot | sh:NodeShape | xsd:boolean | Indicates that the nodeshape should be used to create root nodes for the items in the collection. |
| hanami:readonly | sh:PropertyShape | xsd:boolean | Set to true when a property should only be visible in the UI, but not be editable by the user. Default value is false |
Object properties
| property | domain | range | description |
|---|
| hanami:purpose | sh:Shape | hanami:Purpose | Indicates the purpose of a shape. Either hanami:ValidationPurpose to validate the shape, or hanami:EditionPurpose to show it in the UI. When omitted, both purposes are used. |
| hanami:viewer | sh:NodeShape | hanami:Viewer | Indicates which viewer should be used to view instances of the class the nodeshape targets. Consult the dedicated section on classes to see which kind of viewers are available and how they can be configured. |
| hanami:editor | sh:PropertyShape | hanami:Editor | Indicates which editor should be used to edit the property. Consult the dedicated section on classes to see which kind of editors are available and how they can be configured. |
| hanami:listOf | sh:PropertyShape | sh:PropertyShape | Indicates that the values of the property should be a list of a certain type. |
| hanami:selection | sh:PropertyShape | rdfs:Class | (experimental) Must have value hanami:Item, indicating that the property can reference any item in Hanami. |
Properties on hanami:Collection
Data properties
| property | domain | datatype | description |
|---|
| hanami:baseUri | hanami:Collection | xsd:string | Is used as baseUri when generating a URI for a newly created item |
| hanami:allowMultipleRoots | hanami:Collection | xsd:boolean | Indicates if items in the collection can have multiple root nodes. Default is false |
Object properties
| property | domain | range | description |
|---|
| hanami:elasticsearch | hanami:Collection | hanami:Elasticsearch | Indicates which Elasticsearch connection should be used for indexing and faceted search |
| hanami:rdfStore | hanami:Collection | hanami:RdfStore | Indicates where the data of this collection is stored. |
| hanami:shapes | hanami:Collection | sh:NodeShape | Indicates which nodeshapes should be used to render the form for items in this collection |
| hanami:workspace | hanami:Collection | hanami:Workspace | Indicates in which workspace the collection is located |
Properties on hanami:Viewer, hanami:Editor and subclasses
Data properties
| property | domain | datatype | description |
|---|
| hanami:template | hanami:TemplateViewer | xsd:string | A string providing a template to render nodes in the UI |
Object properties
| property | domain | range | description |
|---|
| hanami:linkingStrategy | hanami:NodeEditor | hanami:LinkingStrategy | Specifies where the nodes referenced by an object property are located. To create a new internal node from the property, use hanami:CreateLinkingStrategy or hanami:CreateManualLinkingStrategy (the latter allows the user to specify the URI of the new node). To only allow the user to reference an already existing node, use hanami:InternalReferenceLinkingStrategy or hanami:ExternalReferenceLinkingStrategy, depending on whether or not the node is present in the current item |
| hanami:option | hanami:SelectEditor | rdfs:Resource | Define an exhaustive set of options presented to the user when using a SelectEditor |
Properties for connections
Datatype properties
| property | domain | datatype | description |
|---|
| hanami:connectionString | hanami:RdfStoreConnectionVirtuoso | xsd:string | Specifies the SPARQL endpoint of the Virtuoso instance |
Object properties
| property | domain | range | description |
|---|
| hanami:rdfStoreConnection | hanami:RdfStore | hanami:RdfStoreConnectionVirtuoso | References the connection object of the rdf store. |
| hanami:elasticsearchConnection | hanami:Elasticsearch | hanami:ElasticsearchConnectionBean | References the connection object of the elasticsearch instance |