CollectionPath

org.llm4s.rag.permissions.CollectionPath
See theCollectionPath companion object
final case class CollectionPath

A validated collection path in the hierarchy.

Collection paths use forward-slash separators (e.g., "confluence/EN/archive"). Each segment must contain only alphanumeric characters, underscores, and hyphens.

Value parameters

segments

The path segments (e.g., Seq("confluence", "EN", "archive"))

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def child(name: String): Result[CollectionPath]

Append a child segment to create a new path

Append a child segment to create a new path

Attributes

def depth: Int

The depth of this path (1 for root, 2 for first-level child, etc.)

The depth of this path (1 for root, 2 for first-level child, etc.)

Attributes

def isChildOf(parent: CollectionPath): Boolean

Check if this path is a direct child of the given parent

Check if this path is a direct child of the given parent

Attributes

def isDescendantOf(prefix: CollectionPath): Boolean

Check if this path is a descendant of the given prefix

Check if this path is a descendant of the given prefix

Attributes

def isRoot: Boolean

True if this is a root collection (no parent)

True if this is a root collection (no parent)

Attributes

def name: String

The final segment of the path (the collection name)

The final segment of the path (the collection name)

Attributes

def parent: Option[CollectionPath]

The parent path, if this is not a root collection

The parent path, if this is not a root collection

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def value: String

The full path string (e.g., "confluence/EN/archive")

The full path string (e.g., "confluence/EN/archive")

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product