PrefixMapI (Apache Jena - DBOE Storage 3.16.0)

All Superinterfaces:

Iterable<PrefixEntry>, PrefixMap

All Known Implementing Classes:

PrefixMapIOverStorage
```
public interface PrefixMapI
extends Iterable<PrefixEntry>, PrefixMap
```
Interface for lightweight prefix maps as an implementation and storage view. This is similar to PrefixMapping from Jena Core but it omits any reverse lookup functionality (URI to prefix) and does not impose XML-specific rules (e.g. local names must start with a letter).
The contract does not require an implementation to do any validation unlike the Jena Core PrefixMapping which requires validation of prefixes.

Implementation Note:

The package org.apache.jena.dboe.storage.prefixes in module jena-dboe-storage provides implementations that work with StoragePrefixes which is dataset provision of prefixes on per-named graph basis.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default org.apache.jena.atlas.lib.Pair<String,String>`	`abbrev(String uriStr)` Abbreviate an IRI or return null
`default String`	`abbreviate(String uriStr)` Abbreviate an IRI or return null
`void`	`add(String prefix, String iriString)` Add a prefix, overwrites any existing association
`void`	`clear()` Clear the prefix mappings.
`boolean`	`containsPrefix(String prefix)`
`void`	`delete(String prefix)` Delete a prefix
`default String`	`expand(String prefixedName)` Expand a prefixed name, return null if it can't be expanded
`default String`	`expand(String prefix, String localName)` Expand a prefix, return null if it can't be expanded
`void`	`forEach(BiConsumer<String,String> action)` Apply a `BiConsumer<String, String>` to each entry in the PrefixMap.
`String`	`get(String prefix)` Get the mapping for a prefix (or return null).
`Map<String,String>`	`getMapping()` Returns the underlying mapping.
`default Map<String,String>`	`getMappingCopy()` Returns a copy of the underlying mapping
`StoragePrefixMap`	`getPrefixMapStorage()`
`boolean`	`isEmpty()` Return whether there are any prefix mappings or not.
`default Iterator<PrefixEntry>`	`iterator()` Iterator over all prefix entries.
`default Stream<String>`	`prefixes()` Stream all prefixes.
`default void`	`putAll(Map<String,String> map)` Merge all the entries from the map into this `PrefixMapI`.
`default void`	`putAll(PrefixMap pmap)` Merge one `PrefixMap` into another.
`default void`	`putAll(PrefixMapping pmap)`
`int`	`size()` Return the number of mappings.
`Stream<PrefixEntry>`	`stream()` Stream of over all prefix entries.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface org.apache.jena.riot.system.PrefixMap
add, contains

- Method Detail
  - getMapping
```
Map<String,String> getMapping()
```
    Returns the underlying mapping. Do not modify this map, call interface operations.
    
    Specified by:
    
    getMapping in interface PrefixMap
  - getMappingCopy
```
default Map<String,String> getMappingCopy()
```
    Returns a copy of the underlying mapping
    
    Specified by:
    
    getMappingCopy in interface PrefixMap
  - getPrefixMapStorage
```
StoragePrefixMap getPrefixMapStorage()
```
  - add
```
void add(String prefix,
         String iriString)
```
    Add a prefix, overwrites any existing association
    
    Specified by:
    
    add in interface PrefixMap
  - putAll
```
default void putAll(PrefixMap pmap)
```
    Merge one PrefixMap into another.
    
    Specified by:
    
    putAll in interface PrefixMap
  - putAll
```
default void putAll(PrefixMapping pmap)
```
    Specified by:
    
    putAll in interface PrefixMap
  - putAll
```
default void putAll(Map<String,String> map)
```
    Merge all the entries from the map into this PrefixMapI.
    
    Specified by:
    
    putAll in interface PrefixMap
  - delete
```
void delete(String prefix)
```
    Delete a prefix
    
    Specified by:
    
    delete in interface PrefixMap
  - clear
```
void clear()
```
    Clear the prefix mappings.
    
    Specified by:
    
    clear in interface PrefixMap
  - get
```
String get(String prefix)
```
    Get the mapping for a prefix (or return null).
  - containsPrefix
```
boolean containsPrefix(String prefix)
```
    Specified by:
    
    containsPrefix in interface PrefixMap
  - abbreviate
```
default String abbreviate(String uriStr)
```
    Abbreviate an IRI or return null
    
    Specified by:
    
    abbreviate in interface PrefixMap
  - abbrev
```
default org.apache.jena.atlas.lib.Pair<String,String> abbrev(String uriStr)
```
    Abbreviate an IRI or return null
    
    Specified by:
    
    abbrev in interface PrefixMap
  - expand
```
default String expand(String prefixedName)
```
    Expand a prefixed name, return null if it can't be expanded
    
    Specified by:
    
    expand in interface PrefixMap
  - expand
```
default String expand(String prefix,
                      String localName)
```
    Expand a prefix, return null if it can't be expanded
    
    Specified by:
    
    expand in interface PrefixMap
  - iterator
```
default Iterator<PrefixEntry> iterator()
```
    Iterator over all prefix entries.
    
    Specified by:
    
    iterator in interface Iterable<PrefixEntry>
  - forEach
```
void forEach(BiConsumer<String,String> action)
```
    Apply a BiConsumer<String, String> to each entry in the PrefixMap.
    
    Specified by:
    
    forEach in interface PrefixMap
  - stream
```
Stream<PrefixEntry> stream()
```
    Stream of over all prefix entries.
  - prefixes
```
default Stream<String> prefixes()
```
    Stream all prefixes.
  - isEmpty
```
boolean isEmpty()
```
    Return whether there are any prefix mappings or not.
    
    Specified by:
    
    isEmpty in interface PrefixMap
  - size
```
int size()
```
    Return the number of mappings.
    
    Specified by:
    
    size in interface PrefixMap

Interface PrefixMapI

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.apache.jena.riot.system.PrefixMap

Method Detail

getMapping

getMappingCopy

getPrefixMapStorage

add

putAll

putAll

putAll

delete

clear

get

containsPrefix

abbreviate

abbrev

expand

expand

iterator

forEach

stream

prefixes

isEmpty

size