Class ExpansionApi

    • Field Detail

      • documentUri

        private final java.net.URI documentUri
      • document

        private final Document document
    • Constructor Detail

      • ExpansionApi

        public ExpansionApi​(java.net.URI documentUri)
      • ExpansionApi

        public ExpansionApi​(Document document)
    • Method Detail

      • context

        public ExpansionApi 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<ExpansionApi>
        Parameters:
        contextUri - URI referring to a context
        Returns:
        builder instance
      • context

        public ExpansionApi 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<ExpansionApi>
        Parameters:
        contextLocation - IRI referring to a context
        Returns:
        builder instance
      • context

        public ExpansionApi 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<ExpansionApi>
        Parameters:
        context - JsonObject, a sequence of JsonObject, or a JsonString representing an IRI
        Returns:
        builder instance
      • base

        public ExpansionApi 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<ExpansionApi>
        Returns:
        builder instance
      • loader

        public ExpansionApi 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<ExpansionApi>
        Returns:
        builder instance
      • ordered

        public ExpansionApi 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<ExpansionApi>
        Returns:
        builder instance
      • get

        public jakarta.json.JsonArray get()
                                   throws JsonLdError
        Get the result of the document expansion.
        Returns:
        JsonArray representing expanded document
        Throws:
        JsonLdError
      • numericId

        public ExpansionApi numericId()
        Experimental: Accept numeric @id. Disabled by default.
        Returns:
        builder instance
      • rdfStar

        public ExpansionApi rdfStar()
        Experimental: Enables JSON-LD-STAR extension. Disabled by default.
        Returns:
        builder instance
        See Also:
        JSON-LD-STAR Draft