ResourceTopicMapSource (Ontopia)

java.lang.Object
- net.ontopia.topicmaps.entry.ResourceTopicMapSource

All Implemented Interfaces:

AutoCloseable, TopicMapSourceIF
```
public class ResourceTopicMapSource
extends Object
implements TopicMapSourceIF
```
INTERNAL: TopicMapSourceIF that can reference individual topic map documents that contained in the classpath and can be loaded by a ClassLoader. The properties id, title, resourceName, and syntax are the most commonly used.

Since:

5.1

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ResourceTopicMapSource.REF_TYPE

Nested Classes
Modifier and Type	Class and Description
`static class`	`ResourceTopicMapSource.REF_TYPE`

Field Summary

Fields
Modifier and Type	Field and Description
`protected LocatorIF`	`base_address`
`protected boolean`	`duplicate_suppression`
`protected boolean`	`hidden`
`protected String`	`id`
`protected ExternalReferenceHandlerIF`	`ref_handler`
`protected ResourceTopicMapSource.REF_TYPE`	`ref_type`
`protected String`	`refid`
`protected Collection<TopicMapReferenceIF>`	`reflist`
`protected String`	`resourceName`
`protected String`	`syntax`
`protected String`	`title`
`protected boolean`	`validate`

Constructor Summary

Constructors
Constructor and Description
`ResourceTopicMapSource()` INTERNAL: Create a new empty `TopicMapSourceIF` instance.
`ResourceTopicMapSource(String resourceName)` INTERNAL: Create a new `TopicMapSourceIF` instance that references a resource that can be located in the classpath.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` PUBLIC: Closes the source by releasing references it holds to e.g.
`TopicMapReferenceIF`	`createTopicMap(String name, String baseAddress)` PUBLIC: Creates a new topic map in the underlying source and returns a reference to the created topic map.
`LocatorIF`	`getBase()` INTERNAL: Gets the base locator of the topic maps retrieved from the source.
`String`	`getBaseAddress()` INTERNAL: Gets the base address of the topic maps retrieved from the source.
`boolean`	`getDuplicateSuppression()` INTERNAL: Gets the duplicate suppression flag.
`ExternalReferenceHandlerIF`	`getExternalReferenceHandler()` INTERNAL: Gets the external reference handler.
`String`	`getId()` PUBLIC: Gets the id of the source.
`String`	`getReferenceId()` INTERNAL: Gets the id of the topic map reference for this topic map source.
`Collection<TopicMapReferenceIF>`	`getReferences()` PUBLIC: Returns an unmodifiable collection of `TopicMapReferenceIF`s found by the topic map source.
`String`	`getResourceName()` INTERNAL: Gets the resource name of the source topic map.
`String`	`getSyntax()` INTERNAL: Returns the syntax of the document.
`String`	`getTitle()` PUBLIC: Gets the title of the source.
`boolean`	`getValidation()` INTERNAL: Returns true if validation is on, false otherwise.
`void`	`refresh()` PUBLIC: Refreshes the collection of references.
`void`	`setBase(LocatorIF base_address)` INTERNAL: Sets the base locator of the topic maps retrieved from the source.
`void`	`setBaseAddress(String base_address)` INTERNAL: Sets the base address of the topic maps retrieved from the source.
`void`	`setDuplicateSuppression(boolean duplicate_suppression)` INTERNAL: Sets the duplicate suppression flag.
`void`	`setExternalReferenceHandler(ExternalReferenceHandlerIF ref_handler)` INTERNAL: Sets the external reference handler.
`void`	`setId(String id)` PUBLIC: Sets the id of the source.
`void`	`setReferenceId(String refid)` INTERNAL: Sets the id of the topic map reference for this topic map source.
`void`	`setResourceName(String resourceName)` INTERNAL: Sets the resource name of the source topic map.
`void`	`setSyntax(String syntax)` INTERNAL: Specifies the syntax of the document.
`void`	`setTitle(String title)` PUBLIC: Sets the title of the source.
`void`	`setValidation(boolean validate)` INTERNAL: Turn validation of XTM documents according to DTD on or off.
`boolean`	`supportsCreate()` PUBLIC: Returns true if the source supports creating new topic maps with the createTopicMap.
`boolean`	`supportsDelete()` PUBLIC: Returns true if the source supports deleting topic map with the TopicMapReferenceIF.delete() method.

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

- Field Detail
  - id
```
protected String id
```
  - refid
```
protected String refid
```
  - title
```
protected String title
```
  - resourceName
```
protected String resourceName
```
  - ref_type
```
protected ResourceTopicMapSource.REF_TYPE ref_type
```
  - syntax
```
protected String syntax
```
  - hidden
```
protected boolean hidden
```
  - base_address
```
protected LocatorIF base_address
```
  - duplicate_suppression
```
protected boolean duplicate_suppression
```
  - validate
```
protected boolean validate
```
  - ref_handler
```
protected ExternalReferenceHandlerIF ref_handler
```
  - reflist
```
protected Collection<TopicMapReferenceIF> reflist
```
- Constructor Detail
  - ResourceTopicMapSource
```
public ResourceTopicMapSource()
```
    INTERNAL: Create a new empty TopicMapSourceIF instance.
  - ResourceTopicMapSource
```
public ResourceTopicMapSource(String resourceName)
```
    INTERNAL: Create a new TopicMapSourceIF instance that references a resource that can be located in the classpath. An example for a valid resource name is 'net/ontopia/topicmaps/examples/ItalianOpera.ltm'.
    
    Parameters:
    
    resourceName - the name of the topic map resource.
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Gets the id of the source.
    
    Specified by:
    
    getId in interface TopicMapSourceIF
  - setId
```
public void setId(String id)
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Sets the id of the source. Note that this method is intended for use when the source is used in a TopicMapRepositoryIF. The source should throw an UnsupportedOperationException if it does not support setting the id.
    
    Specified by:
    
    setId in interface TopicMapSourceIF
  - getTitle
```
public String getTitle()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Gets the title of the source.
    
    Specified by:
    
    getTitle in interface TopicMapSourceIF
  - setTitle
```
public void setTitle(String title)
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Sets the title of the source.
    
    Specified by:
    
    setTitle in interface TopicMapSourceIF
  - getReferenceId
```
public String getReferenceId()
```
    INTERNAL: Gets the id of the topic map reference for this topic map source.
  - setReferenceId
```
public void setReferenceId(String refid)
```
    INTERNAL: Sets the id of the topic map reference for this topic map source.
  - getSyntax
```
public String getSyntax()
```
    INTERNAL: Returns the syntax of the document.
  - setSyntax
```
public void setSyntax(String syntax)
```
    INTERNAL: Specifies the syntax of the document. This property will be used to ensure that the topic map syntax is correctly recognized. The supported syntaxes are 'XTM', 'LTM', 'RDF' and 'N3'. If the syntax is not specified the class will attempt to guess it by looking at the address suffix.
  - getResourceName
```
public String getResourceName()
```
    INTERNAL: Gets the resource name of the source topic map.
  - setResourceName
```
public void setResourceName(String resourceName)
```
    INTERNAL: Sets the resource name of the source topic map.
  - getBase
```
public LocatorIF getBase()
```
    INTERNAL: Gets the base locator of the topic maps retrieved from the source.
  - setBase
```
public void setBase(LocatorIF base_address)
```
    INTERNAL: Sets the base locator of the topic maps retrieved from the source.
  - getBaseAddress
```
public String getBaseAddress()
```
    INTERNAL: Gets the base address of the topic maps retrieved from the source. The notation is assumed to be 'URI'.
  - setBaseAddress
```
public void setBaseAddress(String base_address)
```
    INTERNAL: Sets the base address of the topic maps retrieved from the source. The notation is assumed to be 'URI'.
  - getDuplicateSuppression
```
public boolean getDuplicateSuppression()
```
    INTERNAL: Gets the duplicate suppression flag. If the flag is true duplicate suppression is to be performed when loading the topic maps.
  - setDuplicateSuppression
```
public void setDuplicateSuppression(boolean duplicate_suppression)
```
    INTERNAL: Sets the duplicate suppression flag. If the flag is true duplicate suppression is to be performed when loading the topic maps.
  - setValidation
```
public void setValidation(boolean validate)
```
    INTERNAL: Turn validation of XTM documents according to DTD on or off. The validation checks if the documents read follow the DTD, and will abort import if they do not.
    
    Parameters:
    
    validate - Will validate if true, will not if false.
  - getValidation
```
public boolean getValidation()
```
    INTERNAL: Returns true if validation is on, false otherwise.
  - setExternalReferenceHandler
```
public void setExternalReferenceHandler(ExternalReferenceHandlerIF ref_handler)
```
    INTERNAL: Sets the external reference handler.
  - getExternalReferenceHandler
```
public ExternalReferenceHandlerIF getExternalReferenceHandler()
```
    INTERNAL: Gets the external reference handler. The reference handler will receive notifications on references to external topics and topic maps.
  - getReferences
```
public Collection<TopicMapReferenceIF> getReferences()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Returns an unmodifiable collection of TopicMapReferenceIFs found by the topic map source.
    
    Specified by:
    
    getReferences in interface TopicMapSourceIF
  - refresh
```
public void refresh()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Refreshes the collection of references. This lets the source look at its underlying data source to reflect any changes made since the last refresh.
    
    Specified by:
    
    refresh in interface TopicMapSourceIF
  - close
```
public void close()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Closes the source by releasing references it holds to e.g. database or file system objects.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface TopicMapSourceIF
  - supportsCreate
```
public boolean supportsCreate()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Returns true if the source supports creating new topic maps with the createTopicMap.
    
    Specified by:
    
    supportsCreate in interface TopicMapSourceIF
  - supportsDelete
```
public boolean supportsDelete()
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Returns true if the source supports deleting topic map with the TopicMapReferenceIF.delete() method.
    
    Specified by:
    
    supportsDelete in interface TopicMapSourceIF
  - createTopicMap
```
public TopicMapReferenceIF createTopicMap(String name,
                                          String baseAddress)
```
    Description copied from interface: TopicMapSourceIF
    
    PUBLIC: Creates a new topic map in the underlying source and returns a reference to the created topic map. The method takes a name and the base address for the topic map to create.
    
    Specified by:
    
    createTopicMap in interface TopicMapSourceIF

Class ResourceTopicMapSource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

refid

title

resourceName

ref_type

syntax

hidden

base_address

duplicate_suppression

validate

ref_handler

reflist

Constructor Detail

ResourceTopicMapSource

ResourceTopicMapSource

Method Detail

getId

setId

getTitle

setTitle

getReferenceId

setReferenceId

getSyntax

setSyntax

getResourceName

setResourceName

getBase

setBase

getBaseAddress

setBaseAddress

getDuplicateSuppression

setDuplicateSuppression

setValidation

getValidation

setExternalReferenceHandler

getExternalReferenceHandler

getReferences

refresh

close

supportsCreate

supportsDelete

createTopicMap