Class/Object

razie.wiki.model

WID

Related Docs: object WID | package model

Permalink

case class WID(cat: String, name: String, parent: Option[ObjectId] = None, section: Option[String] = None, realm: Option[String] = None) extends Product with Serializable

a wiki id, a pair of cat and name - can reference a wiki entry or a section of an entry

THIS IS how topics are referenced everywhere in code. In DB they are reference with UWID

format is parent/realm.cat:name#section

assumption is that when we link between wikis, we'll have wiki/parent/cat:name#section -

NOTE: equals does not look at parent !!!

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WID
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WID(cat: String, name: String, parent: Option[ObjectId] = None, section: Option[String] = None, realm: Option[String] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def ahref: String

    Permalink
  5. def ahrefNice(fromRealm: String = Wikis.RK): String

    Permalink
  6. def ahrefRelative(fromRealm: String = Wikis.RK): String

    Permalink
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def canonpath: String

    Permalink

    canonical path - may be different from wpath

  9. val cat: String

    Permalink
  10. def cats: String

    Permalink

    cat with realm

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def content: Option[String]

    Permalink

    get textual content, unprocessed, of this object, if found

  13. def defaultRealmTo(r: String): WID

    Permalink

    withRealm - dn't overwrite realm if set already

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(other: Any): Boolean

    Permalink

    some topics don't use cats

    some topics don't use cats

    Definition Classes
    WID → Equals → AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def findCat(curRealm: String): Option[String]

    Permalink

    find the category, if missing

  18. def findCat: Option[String]

    Permalink

    find the category, if missing

  19. def findId(curRealm: String): Option[ObjectId]

    Permalink

    find the ID for this page, if any - respects the NOCATS

  20. def findId: Option[ObjectId]

    Permalink

    find the ID for this page, if any - respects the NOCATS

  21. lazy val findParent: Option[WikiEntry]

    Permalink
  22. def findSection: Option[WikiSection]

    Permalink

    find the full section, if one is referenced

  23. def formatted: WID

    Permalink
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def getLabel(): String

    Permalink
  26. def getRealm: String

    Permalink

    if wid has no realm, should get the realm or the default - note taht the CAT prefix rules

  27. lazy val grated: com.mongodb.casbah.Imports.DBObject

    Permalink
  28. def isEmpty: Boolean

    Permalink
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def label(action: String): String

    Permalink
  31. def label(action: String, alt: String): String

    Permalink

    helper to get a label, if defined or the default provided

  32. val name: String

    Permalink
  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. lazy val page: Option[WikiEntry]

    Permalink

    find the page for this, if any - respects the NOCATS

  37. val parent: Option[ObjectId]

    Permalink
  38. def parentOf(category: (String) ⇒ Boolean): Option[WID]

    Permalink

    find a parent of the given category

  39. lazy val parentWid: Option[WID]

    Permalink
  40. def r(r: String): WID

    Permalink

    withRealm - convienience builder.

    withRealm - convienience builder. Note that you can't override a category prefix

  41. val realm: Option[String]

    Permalink
  42. val section: Option[String]

    Permalink
  43. def shouldIndex: Boolean

    Permalink

    should this entry be indexed in memory

  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def toSpecPath: WidSpecPath

    Permalink
  46. def toString(): String

    Permalink
    Definition Classes
    WID → AnyRef → Any
  47. def url: String

    Permalink

    the canonical URL with the proper hostname for reactor

  48. def urlRelative(fromRealm: String): String

    Permalink

    use when coming from a known realm

  49. def urlRelative: String

    Permalink
  50. def urlRemote: String

    Permalink

    even when running in localhost mode, use the remote url

  51. def uwid: Option[UWID]

    Permalink
  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def wpath: String

    Permalink

    format into nice url

  56. def wpathFull: String

    Permalink

    full categories allways, with realm prefix if not RK

  57. def wpathnocats: String

    Permalink

    this one used for simple cats with /w/:realm

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped