org.openimaj.rdf.owl2java

Class PropertyDef

java.lang.Object

org.openimaj.rdf.owl2java.PropertyDef

public class PropertyDef
extends Object

Represents the definition of a property of a class.

Version:

$Author$, $Revision$, $Date$

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

29 Oct 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PropertyDef.PropertyType The type of the property.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	absoluteCardinality The absolute number of occurrences of this property that must occur
protected String	comment The comment on this property
protected List<org.openrdf.model.URI>	domain The domain of the property
protected static HashMap<org.openrdf.model.URI,String>	importMap A map of XML Schema types to imports
protected int	maxCardinality The maximum number of occurrences of this property allowed
protected int	minCardinality The minimum number of occurrences of this property allowed
protected List<org.openrdf.model.URI>	range The range of the property (for Object properties)
protected PropertyDef.PropertyType	type The type of this property
protected static HashMap<org.openrdf.model.URI,String>	typeMap A map of XML Schema types to Java types
protected org.openrdf.model.URI	uri The URI of this property
protected static HashMap<org.openrdf.model.URI,URL>	uriResolveMap A map of URIs which must be resolved with the provided generator if it exists

Constructor Summary

Constructors

Constructor and Description
PropertyDef(Generator.GeneratorOptions go)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDeclarationType() Returns the Java declaration type for this property
protected static List<org.openrdf.model.URI>	getURIList(org.openrdf.model.URI listNode, org.openrdf.repository.RepositoryConnection conn) For a given URI that represents a node in an RDF Collection, will returns all the items in the list.
protected static List<org.openrdf.model.URI>	getURIListBNode(org.openrdf.sail.memory.model.MemBNode bNode) Gets a list of URIs from a bnode that's part of an RDF Collection.
int	hashCode()
List<String>	needsImport(boolean implementation) Returns the import required for the Java declaration of this property.
String	toJavaDefinition(String prefix, boolean generateAnnotations) Outputs a Java definition for the property, including a comment if there is a comment for the property.
String	toSettersAndGetters(String prefix, boolean implementations, String delegationObject, boolean indexedRatherThanCollections) Generates setters and getters for the property.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

typeMap

protected static HashMap<org.openrdf.model.URI,String> typeMap

A map of XML Schema types to Java types

importMap

protected static HashMap<org.openrdf.model.URI,String> importMap

A map of XML Schema types to imports

uriResolveMap

protected static HashMap<org.openrdf.model.URI,URL> uriResolveMap

A map of URIs which must be resolved with the provided generator if it exists

uri

protected org.openrdf.model.URI uri

The URI of this property

comment

protected String comment

The comment on this property

type

protected PropertyDef.PropertyType type

The type of this property

range

protected List<org.openrdf.model.URI> range

The range of the property (for Object properties)

domain

protected List<org.openrdf.model.URI> domain

The domain of the property

maxCardinality

protected int maxCardinality

The maximum number of occurrences of this property allowed

minCardinality

protected int minCardinality

The minimum number of occurrences of this property allowed

absoluteCardinality

protected int absoluteCardinality

The absolute number of occurrences of this property that must occur

Constructor Detail

PropertyDef

public PropertyDef(Generator.GeneratorOptions go)

Parameters:

go -

Method Detail

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

needsImport

public List<String> needsImport(boolean implementation)

Returns the import required for the Java declaration of this property. If no import is required, then an empty list will be returned.

Parameters:

implementation - Whether we're generating implementations or interfaces

Returns:

The import type as a string.

getDeclarationType

public String getDeclarationType()

Returns the Java declaration type for this property

Returns:

A string

toJavaDefinition

public String toJavaDefinition(String prefix,
                               boolean generateAnnotations)

Outputs a Java definition for the property, including a comment if there is a comment for the property. The comment will be formatted slightly differently if it's very long. If generateAnnotations is true, then a Predicate annotation will be generated for each declaration containing the URI of the property. DataType properties will be encoded as Strings and Object properties will be declared as their appropriate type.

Parameters:

prefix - The String prefix to add to all lines in the generated code

generateAnnotations - Whether to generate @@Predicate annotations

Returns:

A string containing a Java definition

toSettersAndGetters

public String toSettersAndGetters(String prefix,
                                  boolean implementations,
                                  String delegationObject,
                                  boolean indexedRatherThanCollections)

Generates setters and getters for the property.

Parameters:

prefix -

implementations -

delegationObject -

indexedRatherThanCollections -

Returns:

A string containing setters and getters

getURIList

protected static List<org.openrdf.model.URI> getURIList(org.openrdf.model.URI listNode,
                                                        org.openrdf.repository.RepositoryConnection conn)

For a given URI that represents a node in an RDF Collection, will returns all the items in the list.

Parameters:

listNode - The URI of the list node

conn - The repository connection

Returns:

A list of URIs from the RDF list

getURIListBNode

protected static List<org.openrdf.model.URI> getURIListBNode(org.openrdf.sail.memory.model.MemBNode bNode)

Gets a list of URIs from a bnode that's part of an RDF Collection.

Parameters:

bNode - The Bnode

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object