Skip to content

Commit e1bf397

Browse files
Doc comments
1 parent c57c12d commit e1bf397

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

binary-array-ld-lib/src/main/kotlin/net/bald/context/ModelContext.kt

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,29 @@ import org.apache.jena.rdf.model.Resource
55
import org.apache.jena.shared.PrefixMapping
66

77
/**
8-
* TODO
8+
* The external context in which a binary array can be resolved.
9+
* This includes resource and property aliases as defined by [AliasDefinition]
10+
* and the available namespace prefix mappings.
911
* @see AliasDefinition
1012
*/
1113
interface ModelContext: AliasDefinition {
1214
/**
13-
* TODO
15+
* Prefix mappings that are available in this context.
1416
*/
1517
val prefixMapping: PrefixMapping
1618

19+
/**
20+
* A substitute [ModelContext] implementation that represents a null or empty context.
21+
*/
1722
object Empty: ModelContext {
1823
override val prefixMapping: PrefixMapping get() = PrefixMapping.Factory.create()
1924
override fun property(identifier: String): Property? = null
2025
override fun resource(identifier: String): Resource? = null
2126
}
2227

28+
/**
29+
* A basic [ModelContext] implementation that simply composes the prefix mapping and alias elements.
30+
*/
2331
class Base(
2432
override val prefixMapping: PrefixMapping,
2533
private val alias: AliasDefinition

binary-array-ld-netcdf/src/main/kotlin/net/bald/netcdf/NetCdfBinaryArray.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class NetCdfBinaryArray(
6666
* The resulting [NetCdfBinaryArray] should be closed after use.
6767
* @param fileLoc The location of the NetCDF file on the local file system.
6868
* @param uri The URI which identifies the dataset.
69-
* @param context TODO
69+
* @param context The external context in which to resolve the binary array.
7070
* @return A [BinaryArray] representation of the NetCDF file.
7171
*/
7272
@JvmStatic

binary-array-ld-netcdf/src/main/kotlin/net/bald/netcdf/NetCdfRootContainer.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class NetCdfRootContainer(
1212
private val ba: NetCdfBinaryArray,
1313
group: Group,
1414
): NetCdfContainer(group) {
15-
override val uri: String get() = ba.uri + "/" // TODO trailing slash???
15+
override val uri: String get() = ba.uri + "/"
1616
override val context: ModelContext get() = ba.context
1717
override val uriParser: UriParser get() = UriParser(ba.prefixMapping)
1818

0 commit comments

Comments
 (0)