ModelDocument (PGR ontology model 0.7.1 API)

java.lang.Object
- org.genesys2.rdf.model.rdf.ModelDocument

Direct Known Subclasses:

DarwinCore, DarwinCoreAttributes, DCMI, DescriptorOntology, DublinCore, FOAF, RDFSchema, WGS94GeoPositioning
```
public abstract class ModelDocument
extends Object
```
The Class ModelDocument.

Author:

rbruskiewich

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`_trace_level` The _trace_level.
`static String`	`COMMENT` The Constant COMMENT.
`static int`	`DEBUG` The Constant VERBOSE.
`static String`	`DESCRIPTION` The Constant DESCRIPTION.
`static String`	`DOMAIN` The Constant DOMAIN.
`static int`	`INFO` The Constant VERBOSE.
`static String`	`LABEL` The Constant LABEL.
`static String`	`MEMBER` The Constant MEMBER.
`protected String`	`modelURI` The model uri.
`static int`	`NONE` The Constant VERBOSE.
`static String`	`RANGE` The Constant RANGE.
`static String`	`SUB_CLASS_OF` The Constant SUB_CLASS_OF.
`static String`	`SUB_PROPERTY_OF` The Constant SUB_PROPERTY_OF.
`static int`	`VERBOSE` The Constant VERBOSE.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ModelDocument(String modelURI)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`ModelDocument(String modelURI)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,String>`	`_load(Map<String,String> targetMap, Map<String,String> sourceMap, String label)` Utility method for property Map management.
`Map<String,String>`	`classDetails(String termURI, String language)` Method to document rdfs:Class resource specific details.
`Map<String,String>`	`classes()` Classes.
`Map<String,String>`	`collections()` Method to compile and return a catalog Map of collections with list of members.
`void`	`dumpModel()` Default is to dump the model in N3 format on stdout.
`void`	`dumpModel(OutputStream output)` Default is to dump the model in N3 format on stdout.
`void`	`dumpModel(OutputStream out, String format)` Dump model.
`void`	`dumpModel(String format)` Dump model.
`void`	`dumpModel(String fileName, String format)` Dump model.
`void`	`dumpSchema()` Method dumpSchema with default language.
`void`	`dumpSchema(String language)` Dump schema.
`static ModelDocument`	`lookup(String uri)` Method with default language.
`static ModelDocument`	`lookup(String uri, String language)` Lookup.
`Map<String,String>`	`members(String collectionURI)` Method to return the members of a skos:Collection, as complete URI's.
`Parser`	`parser()` Parser.
`Map<String,String>`	`properties()` Properties.
`Map<String,String>`	`propertyDetails(String termURI, String language)` Method to document rdfs:Class resource specific details.
`protected void`	`setLanguage(String language)` Method.
`Map<String,String>`	`subjectsOfType(String typeURI)` Subjects of type.
`static void`	`trace(int level)` Trace.
`protected ModelDocument`	`translatedModel()` Method that returns the ModelDocument associated with the current language translation associated with the core RDF model (i.e.
`String`	`URI()` Uri.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    The Constant VERBOSE.
    
    See Also:
    
    Constant Field Values
  - INFO
```
public static final int INFO
```
    The Constant VERBOSE.
    
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static final int DEBUG
```
    The Constant VERBOSE.
    
    See Also:
    
    Constant Field Values
  - VERBOSE
```
public static final int VERBOSE
```
    The Constant VERBOSE.
    
    See Also:
    
    Constant Field Values
  - _trace_level
```
public static int _trace_level
```
    The _trace_level.
  - LABEL
```
public static final String LABEL
```
    The Constant LABEL.
    
    See Also:
    
    Constant Field Values
  - COMMENT
```
public static final String COMMENT
```
    The Constant COMMENT.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final String DESCRIPTION
```
    The Constant DESCRIPTION.
    
    See Also:
    
    Constant Field Values
  - SUB_CLASS_OF
```
public static final String SUB_CLASS_OF
```
    The Constant SUB_CLASS_OF.
    
    See Also:
    
    Constant Field Values
  - SUB_PROPERTY_OF
```
public static final String SUB_PROPERTY_OF
```
    The Constant SUB_PROPERTY_OF.
    
    See Also:
    
    Constant Field Values
  - MEMBER
```
public static final String MEMBER
```
    The Constant MEMBER.
    
    See Also:
    
    Constant Field Values
  - DOMAIN
```
public static final String DOMAIN
```
    The Constant DOMAIN.
    
    See Also:
    
    Constant Field Values
  - RANGE
```
public static final String RANGE
```
    The Constant RANGE.
    
    See Also:
    
    Constant Field Values
  - modelURI
```
protected String modelURI
```
    The model uri.
- Constructor Detail
  - ModelDocument
```
protected ModelDocument(String modelURI)
                 throws IOException,
                        ModelException
```
    Constructor.
    
    Parameters:
    
    modelURI - of RDF document to load
    
    Throws:
    
    IOException - - if model file cannot be accessed ModelException - if invalid modelURI parameter specified
    
    ModelException - the model exception
- Method Detail
  - trace
```
public static void trace(int level)
```
    Trace.
    
    Parameters:
    
    level - the level
  - URI
```
public String URI()
```
    Uri.
    
    Returns:
    
    the string
  - parser
```
public Parser parser()
```
    Parser.
    
    Returns:
    
    the parser
  - setLanguage
```
protected void setLanguage(String language)
                    throws IOException,
                           ModelException
```
    Method.
    
    Parameters:
    
    language - the new language
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
    
    ModelException - the model exception
  - translatedModel
```
protected ModelDocument translatedModel()
```
    Method that returns the ModelDocument associated with the current language translation associated with the core RDF model (i.e. RDF property Literals encoded in the non-default language)
    
    Returns:
    
    the model document
  - dumpModel
```
public void dumpModel(OutputStream out,
                      String format)
```
    Dump model.
    
    Parameters:
    
    out - the out
    
    format - to output file
  - dumpModel
```
public void dumpModel(String fileName,
                      String format)
```
    Dump model.
    
    Parameters:
    
    fileName - the file name
    
    format - to output file
  - dumpModel
```
public void dumpModel(String format)
```
    Dump model.
    
    Parameters:
    
    format - to stdout
  - dumpModel
```
public void dumpModel()
```
    Default is to dump the model in N3 format on stdout.
  - dumpModel
```
public void dumpModel(OutputStream output)
```
    Default is to dump the model in N3 format on stdout.
    
    Parameters:
    
    output - the output
  - subjectsOfType
```
public Map<String,String> subjectsOfType(String typeURI)
                                  throws RDFParserException
```
    Subjects of type.
    
    Parameters:
    
    typeURI - the type uri
    
    Returns:
    
    the map
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - classes
```
public Map<String,String> classes()
                           throws RDFParserException
```
    Classes.
    
    Returns:
    
    list of resources of type rdfs:Class
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - properties
```
public Map<String,String> properties()
                              throws RDFParserException
```
    Properties.
    
    Returns:
    
    list of resources of type rdf:Property
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - members
```
public Map<String,String> members(String collectionURI)
                           throws RDFParserException
```
    Method to return the members of a skos:Collection, as complete URI's.
    
    Parameters:
    
    collectionURI - the collection uri
    
    Returns:
    
    the map
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - collections
```
public Map<String,String> collections()
                               throws RDFParserException
```
    Method to compile and return a catalog Map of collections with list of members.
    
    Returns:
    
    the map
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - _load
```
protected Map<String,String> _load(Map<String,String> targetMap,
                                   Map<String,String> sourceMap,
                                   String label)
```
    Utility method for property Map management.
    
    Parameters:
    
    targetMap - the target map
    
    sourceMap - the source map
    
    label - the label
    
    Returns:
    
    the map
  - classDetails
```
public Map<String,String> classDetails(String termURI,
                                       String language)
                                throws RDFParserException
```
    Method to document rdfs:Class resource specific details.
    
    Parameters:
    
    termURI - the term uri
    
    language - the language
    
    Returns:
    
    the map
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - propertyDetails
```
public Map<String,String> propertyDetails(String termURI,
                                          String language)
                                   throws RDFParserException
```
    Method to document rdfs:Class resource specific details.
    
    Parameters:
    
    termURI - the term uri
    
    language - the language
    
    Returns:
    
    the map
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - dumpSchema
```
public void dumpSchema(String language)
```
    Dump schema.
    
    Parameters:
    
    language - the language
  - dumpSchema
```
public void dumpSchema()
```
    Method dumpSchema with default language.
  - lookup
```
public static ModelDocument lookup(String uri,
                                   String language)
                            throws RDFParserException
```
    Lookup.
    
    Parameters:
    
    uri - the uri
    
    language - the language
    
    Returns:
    
    the model document
    
    Throws:
    
    RDFParserException - the RDF parser exception
  - lookup
```
public static ModelDocument lookup(String uri)
                            throws RDFParserException
```
    Method with default language.
    
    Parameters:
    
    uri - the uri
    
    Returns:
    
    the model document
    
    Throws:
    
    RDFParserException - the RDF parser exception

Class ModelDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

INFO

DEBUG

VERBOSE

_trace_level

LABEL

COMMENT

DESCRIPTION

SUB_CLASS_OF

SUB_PROPERTY_OF

MEMBER

DOMAIN

RANGE

modelURI

Constructor Detail

ModelDocument

Method Detail

trace

URI

parser

setLanguage

translatedModel

dumpModel

dumpModel

dumpModel

dumpModel

dumpModel

subjectsOfType

classes

properties

members

collections

_load

classDetails

propertyDetails

dumpSchema

dumpSchema

lookup

lookup