Class FlatteningApi

    • Field Detail

      • documentUri

        private final java.net.URI documentUri
      • document

        private final Document document
      • contextUri

        private java.net.URI contextUri
    • Constructor Detail

      • FlatteningApi

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

        public FlatteningApi​(Document document)
    • Method Detail

      • base

        public FlatteningApi 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<FlatteningApi>
        Returns:
        builder instance
      • compactArrays

        public FlatteningApi compactArrays​(boolean enable)
      • loader

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

        public FlatteningApi 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<FlatteningApi>
        Returns:
        builder instance
      • context

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

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

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

        public jakarta.json.JsonStructure get()
                                       throws JsonLdError
        Get the result of flattening.
        Returns:
        JsonStructure representing flattened document
        Throws:
        JsonLdError