Class FramingApi

    • Field Detail

      • document

        private final Document document
      • documentUri

        private final java.net.URI documentUri
      • frameUri

        private final java.net.URI frameUri
    • Constructor Detail

      • FramingApi

        public FramingApi​(java.net.URI documentUri,
                          java.net.URI frameUri)
      • FramingApi

        public FramingApi​(Document document,
                          java.net.URI frameUri)
      • FramingApi

        public FramingApi​(java.net.URI documentUri,
                          Document frame)
    • Method Detail

      • context

        public FramingApi context​(java.net.URI contextUri)
        Description copied from interface: ContextApi
        A context that is used to initialize the active context.
        Specified by:
        context in interface ContextApi<FramingApi>
        Parameters:
        contextUri - URI referring to a context
        Returns:
        builder instance
      • context

        public FramingApi context​(java.lang.String contextLocation)
        Description copied from interface: ContextApi
        A context that is used to initialize the active context.
        Specified by:
        context in interface ContextApi<FramingApi>
        Parameters:
        contextLocation - IRI referring to a context
        Returns:
        builder instance
      • context

        public FramingApi context​(jakarta.json.JsonStructure context)
        Description copied from interface: ContextApi
        A context that is used to initialize the active context.
        Specified by:
        context in interface ContextApi<FramingApi>
        Parameters:
        context - JsonObject, a sequence of JsonObject, or a JsonString representing an IRI
        Returns:
        builder instance
      • mode

        public FramingApi mode​(JsonLdVersion processingMode)
        Description copied from interface: CommonApi
        Set JSON-LD processing mode. JSON-LD 1.1 is set by default.
        Specified by:
        mode in interface CommonApi<FramingApi>
        Parameters:
        processingMode - to set
        Returns:
        builder instance
      • base

        public FramingApi base​(java.net.URI baseUri)
        Description copied from interface: CommonApi
        Set the base IRI. If set, this overrides the input document's IRI.
        Specified by:
        base in interface CommonApi<FramingApi>
        Returns:
        builder instance
      • loader

        public FramingApi loader​(DocumentLoader loader)
        Description copied from interface: LoaderApi
        Set the loader to be used to retrieve remote documents and contexts, implementing the DocumentLoader. If specified, it is used to retrieve remote documents and contexts; otherwise, if not specified, the processor's built-in loader is used.
        Specified by:
        loader in interface LoaderApi<FramingApi>
        Returns:
        builder instance
      • ordered

        public FramingApi ordered​(boolean enable)
        Description copied from interface: CommonApi
        If set to true, certain algorithm processing steps are ordered lexicographically. If false, order is not considered in processing.
        Specified by:
        ordered in interface CommonApi<FramingApi>
        Returns:
        builder instance
      • explicit

        public FramingApi explicit​(boolean enable)
      • omitDefault

        public FramingApi omitDefault​(boolean enable)
      • omitGraph

        public FramingApi omitGraph​(boolean enable)
      • requiredAll

        public FramingApi requiredAll​(boolean enable)
      • get

        public jakarta.json.JsonObject get()
                                    throws JsonLdError
        Get the result of framing.
        Returns:
        JsonObject representing framed document
        Throws:
        JsonLdError