com.github.anno4j.schema_parsing.naming

Class IdentifierBuilder

java.lang.Object

com.github.anno4j.schema_parsing.naming.IdentifierBuilder

Direct Known Subclasses:

ClassNameBuilder, MethodNameBuilder

public class IdentifierBuilder
extends Object

Utility class for generating Java compliant names for resources. Provides functionality for deriving a package name from the hostname portion of URIs. The readability can be enhanced by specifying the rdfs:label of the resource.

Method Summary

Methods

Modifier and Type	Method and Description
String	capitalizedIdentifier(ResourceObject resource, OntGenerationConfig config) Determines a Java compliant identifier for the resource with first character in uppercase (e.g.
String	capitalizedPluralIdentifier(ResourceObject resource, OntGenerationConfig config) Extracts a capitalized plural form for this resource.
static IdentifierBuilder	forObjectRepository(ObjectConnection connection) Returns a builder object that operates on the connected repository.
static IdentifierBuilder	forObjectRepository(ObjectRepository repository) Returns a builder object that operates on the given repository.
String	lowercaseIdentifier(ResourceObject resource, OntGenerationConfig config) Determines a Java compliant identifier for the resource with first character in lowercase (e.g.
String	lowercasePluralIdentifier(ResourceObject resource, OntGenerationConfig config) Extracts a plural form for this resource.
String	packageName(ResourceObject object, OntGenerationConfig config) Determines a package name for the type generated for a URI by its hostname component.

Methods inherited from class java.lang.Object

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

Method Detail

forObjectRepository

public static IdentifierBuilder forObjectRepository(ObjectRepository repository)
                                             throws org.openrdf.repository.RepositoryException

Returns a builder object that operates on the given repository.

Parameters:

repository - The repository to use, e.g. for name disambiguation.

Returns:

An instance of the builder.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while opening a connection to the repository.

forObjectRepository

public static IdentifierBuilder forObjectRepository(ObjectConnection connection)

Returns a builder object that operates on the connected repository.

Parameters:

connection - A connection to the repository to use, e.g. for name disambiguation.

Returns:

An instance of the builder.

packageName

public String packageName(ResourceObject object,
                 OntGenerationConfig config)

Determines a package name for the type generated for a URI by its hostname component. If a portion of the hostname contains a hyphen or if it is a Java reserved name or starts with a digit then this portion of the package name is added an underscore (like suggested in Naming a Package). If a portion of the hostname contains a special character that is not a hyphen then this character is left out in the package name. The package structure extracted is appended to the base package defined in config

Parameters:

object - The resource for which to get the package name for.

config - Configuration for Java class generation.

Returns:

Returns the package name for the given resource. If the hostname is a IP address or the resource is a blank node then the default package OntGenerationConfig.getBasePackage() of config is returned.

lowercaseIdentifier

public String lowercaseIdentifier(ResourceObject resource,
                         OntGenerationConfig config)
                           throws org.openrdf.repository.RepositoryException

Determines a Java compliant identifier for the resource with first character in lowercase (e.g. variable names). Removes all characters that are not allowed in identifier names and transforms separations by underscore, hyphen or whitespace to CamelCase. The name is preferably generated from the rdfs:label if it was set.

Parameters:

resource - The resource for which to find a name.

config - The configuration object specifying how names are built.

Returns:

The identifier name that was determined.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while querying the repository.

capitalizedIdentifier

public String capitalizedIdentifier(ResourceObject resource,
                           OntGenerationConfig config)
                             throws org.openrdf.repository.RepositoryException

Determines a Java compliant identifier for the resource with first character in uppercase (e.g. class names). Removes all characters that are not allowed in identifier names and transforms separations by underscore, hyphen or whitespace to CamelCase. The name is preferably generated from the rdfs:label if it was set.

Parameters:

resource - The resource for which to find a name.

config - The configuration object specifying how names are built.

Returns:

The identifier name that was determined.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while querying the repository.

lowercasePluralIdentifier

public String lowercasePluralIdentifier(ResourceObject resource,
                               OntGenerationConfig config)
                                 throws org.openrdf.repository.RepositoryException

Extracts a plural form for this resource. A trailing "s" is added and some simple grammatical rules (for english) are applied.

Parameters:

resource - The resource for which to find a name.

config - The configuration object specifying how names are built.

Returns:

Same as lowercaseIdentifier(ResourceObject, OntGenerationConfig), but in a plural form.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while querying the repository.

capitalizedPluralIdentifier

public String capitalizedPluralIdentifier(ResourceObject resource,
                                 OntGenerationConfig config)
                                   throws org.openrdf.repository.RepositoryException

Extracts a capitalized plural form for this resource. A trailing "s" is added and some simple grammatical rules (for english) are applied.

Parameters:

resource - The resource for which to find a name.

config - The configuration object specifying how names are built.

Returns:

Same as capitalizedIdentifier(ResourceObject, OntGenerationConfig), but in a plural form.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while querying the repository.