Class/Object

razie.wiki.model

WikiEntry

Related Docs: object WikiEntry | package model

Permalink

case class WikiEntry(category: String, name: String, label: String, markup: String, content: String, by: com.mongodb.casbah.Imports.ObjectId, tags: Seq[String] = Seq(), realm: String = Wikis.RK, ver: Int = 1, parent: Option[com.mongodb.casbah.Imports.ObjectId] = None, props: Map[String, String] = Map.empty, likes: List[String] = List.empty, dislikes: List[String] = List.empty, likeCount: Int = 0, dislikeCount: Int = 0, crDtm: DateTime = DateTime.now, updDtm: DateTime = DateTime.now, _id: com.mongodb.casbah.Imports.ObjectId = new ObjectId()) extends WikiPage with DSpec with Product with Serializable

a simple wiki-style entry: language (markdown, mediawiki wikidot etc) and the actual source

There is an "owner" property - owner is supposed to have special privileges

Annotations
@RTable()
Linear Supertypes
Serializable, Serializable, Product, Equals, DSpec, WikiPage, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WikiEntry
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DSpec
  7. WikiPage
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WikiEntry(category: String, name: String, label: String, markup: String, content: String, by: com.mongodb.casbah.Imports.ObjectId, tags: Seq[String] = Seq(), realm: String = Wikis.RK, ver: Int = 1, parent: Option[com.mongodb.casbah.Imports.ObjectId] = None, props: Map[String, String] = Map.empty, likes: List[String] = List.empty, dislikes: List[String] = List.empty, likeCount: Int = 0, dislikeCount: Int = 0, crDtm: DateTime = DateTime.now, updDtm: DateTime = DateTime.now, _id: com.mongodb.casbah.Imports.ObjectId = new ObjectId())

    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. final val AUDIT_NOTE_CREATED: String("NOTE_CREATED")

    Permalink
  5. final val AUDIT_NOTE_UPDATED: String("NOTE_UPDATED")

    Permalink
  6. final val AUDIT_WIKI_CREATED: String("WIKI_CREATED")

    Permalink
  7. final val AUDIT_WIKI_DELETED: String("WIKI_DELETED")

    Permalink
  8. final val AUDIT_WIKI_UPDATED: String("WIKI_UPDATED")

    Permalink
  9. val _id: com.mongodb.casbah.Imports.ObjectId

    Permalink
    Definition Classes
    WikiEntryWikiPage
  10. def alias: Option[WID]

    Permalink

    is this just an alias?

    is this just an alias?

    an alias is a topic that starts with the alias markup: alias:xxx

  11. def allProps: Map[String, String]

    Permalink

    all properties contained in this spec, in various forms

    all properties contained in this spec, in various forms

    Definition Classes
    WikiEntryDSpec
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. lazy val ast: (BaseAstNode, String)

    Permalink

    pre processed form - parsed and graphed.

    pre processed form - parsed and graphed. No context is used when parsing - only when folding this AST, so you can reuse the AST

  14. def attr(name: String): Option[String]

    Permalink

    attributes are props perhaps overriden in content

    attributes are props perhaps overriden in content

    Definition Classes
    WikiEntryWikiPage
  15. def auditFlagged(f: String): Unit

    Permalink
  16. val by: com.mongodb.casbah.Imports.ObjectId

    Permalink
    Definition Classes
    WikiEntryWikiPage
  17. var cacheable: Boolean

    Permalink

    set during parsing and folding - false if page has any user-specific elements any scripts or such will make this false this is very pessimistic right now for safety issues: even a whiff of non-static content will turn this off

    set during parsing and folding - false if page has any user-specific elements any scripts or such will make this false this is very pessimistic right now for safety issues: even a whiff of non-static content will turn this off

    Definition Classes
    DSpec
  18. def canonicalUrl: String

    Permalink

    i should be conservative and default to rk.

    i should be conservative and default to rk. Note this doesn't check Config.urlcanon

  19. def cat: String

    Permalink

    category - you can categorize the specs

    category - you can categorize the specs

    Definition Classes
    WikiEntryDSpec
  20. val category: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  21. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def cloneContent(newcontent: String): WikiEntry

    Permalink
  23. def cloneNewVer(label: String, markup: String, content: String, by: com.mongodb.casbah.Imports.ObjectId, props: Map[String, String] = this.props): WikiEntry

    Permalink
  24. def cloneProps(m: Map[String, String], sby: com.mongodb.casbah.Imports.ObjectId): WikiEntry

    Permalink
  25. val collector: HashMap[String, Any]

    Permalink

    other parsing artifacts to be used by knowledgeable modules.

    other parsing artifacts to be used by knowledgeable modules. Parsers can put stuff in here.

    Definition Classes
    WikiEntryDSpec
  26. val content: String

    Permalink

    original text content, not pre-processed - this is generally useless

    original text content, not pre-processed - this is generally useless

    Definition Classes
    WikiEntryDSpecWikiPage
  27. def contentPreProcessed: String

    Permalink

    the content, pre-processed, with includes and macros expanded etc.

    the content, pre-processed, with includes and macros expanded etc. But no parsing done

    NOTE this is not a different representation, like html or something... it is just the content, pre-processed

    todo should be an Either

    Definition Classes
    WikiEntryDSpec
  28. def contentProps: Map[String, String]

    Permalink

    tags collected during parsing of the content, with some static tags like url,label etc

    tags collected during parsing of the content, with some static tags like url,label etc

    Definition Classes
    WikiEntryWikiPage
  29. val crDtm: DateTime

    Permalink
    Definition Classes
    WikiEntryWikiPage
  30. def create: Unit

    Permalink
  31. def delete(sby: String)(implicit txn: Txn): Unit

    Permalink

    backup old version and update entry, update index

  32. var depys: List[UWID]

    Permalink
  33. val dislikeCount: Int

    Permalink
  34. val dislikes: List[String]

    Permalink
  35. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  36. var fields: Map[String, FieldDef]

    Permalink

    field definitions as parsed fields are rendered in WForm

  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def findAttr(name: String): Option[String]

    Permalink

    either from me, parent or reactor

  39. def findParent: Option[WikiEntry]

    Permalink
  40. def findSection(p: (DTemplate) ⇒ Boolean): Option[DTemplate]

    Permalink

    find template with predicate

    find template with predicate

    Definition Classes
    WikiEntryDSpec
  41. def findSection(name: String, tags: String = ""): Option[DTemplate]

    Permalink

    find a template for that name (e-a) or implementing that URL

    find a template for that name (e-a) or implementing that URL

    from DSpec

    Definition Classes
    WikiEntryDSpec
  42. lazy val form: WikiForm

    Permalink
  43. def formRole: Option[String]

    Permalink
  44. def formState: Option[String]

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

    Permalink
    Definition Classes
    AnyRef → Any
  46. def getDescription: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  47. def getFirstParagraph: Option[String]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  48. def getLabel: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  49. def grated: com.mongodb.casbah.Imports.DBObject

    Permalink
  50. def ilinks: List[ILink]

    Permalink

    all the links from this page to others, based on parsed content

  51. def included: String

    Permalink

    todo should use this version instead of content - this resolves includes

    todo should use this version instead of content - this resolves includes

    Definition Classes
    WikiEntryWikiPage
  52. def included2: String

    Permalink
  53. var ipreprocessed: Option[(StrAstNode, Option[WikiUser])]

    Permalink

    AST folded with a context

  54. def isDraft: Boolean

    Permalink

    we support draft specs vs non=draft (published)

    we support draft specs vs non=draft (published)

    Definition Classes
    WikiEntryDSpecWikiPage
  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  56. def isOwner(id: String): Boolean

    Permalink
    Definition Classes
    WikiEntryWikiPage
  57. def isPrivate: Boolean

    Permalink
    Definition Classes
    WikiEntryWikiPage
  58. def isReserved: Boolean

    Permalink
    Definition Classes
    WikiEntryWikiPage
  59. val label: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  60. val likeCount: Int

    Permalink
  61. val likes: List[String]

    Permalink
  62. def linksFrom: Iterator[WikiLink]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  63. def linksTo: Iterator[WikiLink]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  64. val markup: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  65. val name: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  66. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  69. def owner: Option[WikiUser]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  70. def ownerId: Option[ObjectId]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  71. val parent: Option[com.mongodb.casbah.Imports.ObjectId]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  72. def parsed: String

    Permalink

    the actual content, preprocessed

    the actual content, preprocessed

    Definition Classes
    WikiEntryDSpec
  73. def preprocess(au: Option[WikiUser]): StrAstNode

    Permalink
  74. def preprocessed: StrAstNode

    Permalink
  75. val props: Map[String, String]

    Permalink
    Definition Classes
    WikiEntryWikiPage
  76. val realm: String

    Permalink
    Definition Classes
    WikiEntryWikiPage
  77. def redirect: Option[String]

    Permalink

    is this just a redirect?

  78. lazy val scripts: List[WikiSection]

    Permalink

    scripts are just a special section

  79. def scriptsNoInclude: List[WikiSection]

    Permalink
  80. def section(stype: String, name: String): Option[WikiSection]

    Permalink

    find a section

    find a section

    Definition Classes
    WikiEntryWikiPage
  81. lazy val sections: List[WikiSection]

    Permalink

    these are normal - all sections after include

  82. def specPath: SpecPath

    Permalink
    Definition Classes
    WikiEntryDSpec
  83. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  84. val tags: Seq[String]

    Permalink
    Definition Classes
    WikiEntryDSpecWikiPage
  85. lazy val templateSections: List[WikiSection]

    Permalink

    these are when used as a template - template sections do not resolve include

  86. def toString(): String

    Permalink
    Definition Classes
    WikiEntry → AnyRef → Any
  87. val updDtm: DateTime

    Permalink
    Definition Classes
    WikiEntryWikiPage
  88. def update(newVer: WikiEntry, reason: Option[String] = None)(implicit txn: Txn = tx.auto): Option[Unit]

    Permalink

    backup old version and update entry, update index

  89. def uwid: UWID

    Permalink
    Definition Classes
    WikiEntryWikiPage
  90. val ver: Int

    Permalink
    Definition Classes
    WikiEntryWikiPage
  91. def viewCount: Option[Long]

    Permalink
  92. def visibility: String

    Permalink

    visibility of this spec - see razie.tconf.Visibility

    visibility of this spec - see razie.tconf.Visibility

    Definition Classes
    WikiEntryDSpecWikiPage
  93. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. def wid: WID

    Permalink
    Definition Classes
    WikiEntryWikiPage
  97. def withTags(s: Seq[String], sby: com.mongodb.casbah.Imports.ObjectId): WikiEntry

    Permalink
  98. def wordCount: Int

    Permalink
    Definition Classes
    WikiEntryWikiPage
  99. def wvis: String

    Permalink
    Definition Classes
    WikiEntryWikiPage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DSpec

Inherited from WikiPage

Inherited from AnyRef

Inherited from Any

Ungrouped