Module com.semanticcms.core.model

Package com.semanticcms.core.model

Class Book

java.lang.Object

com.semanticcms.core.model.Book

All Implemented Interfaces:

Comparable<Book>

public class Book
extends Object
implements Comparable<Book>

A book contains pages and is the central mechanism for high-level separation of content. Each book usually has its own code repository and a book can be added to multiple webapps.

Constructor Summary

Constructors

Constructor	Description
Book(String name, String cvsworkDirectory, boolean allowRobots, Set<ParentRef> parentRefs, Properties bookProps)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Book o)
boolean	equals(Object obj)
boolean	getAllowRobots()	Gets the allowRobots setting of the book.
Set<Author>	getAuthors()	Gets the authors of the book.
String	getCanonicalBase()	Gets the configured canonicalBase for this book, or null if not configured.
PageRef	getContentRoot()	Gets the content root for the book.
Copyright	getCopyright()	Gets the copyright for the book or null if none declared.
File	getCvsworkDirectory()
String	getName()
Map<String,String>	getParam()
Set<ParentRef>	getParentRefs()	Gets the parent pages for this book in the context of the current overall content.
String	getPathPrefix()	Gets the path prefix for all pages in this book.
String	getTitle()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Book

public Book(String name,
 String cvsworkDirectory,
 boolean allowRobots,
 Set<ParentRef> parentRefs,
 Properties bookProps)

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Book o)

Specified by:

compareTo in interface Comparable<Book>

getName

public String getName()

getPathPrefix

public String getPathPrefix()

Gets the path prefix for all pages in this book. This will be an empty string for the root book (/).

getCvsworkDirectory

public File getCvsworkDirectory()

getParentRefs

public Set<ParentRef> getParentRefs()

Gets the parent pages for this book in the context of the current overall content.

getCanonicalBase

public String getCanonicalBase()

Gets the configured canonicalBase for this book, or null if not configured. Any trailing slash (/) has been stripped from the canonicalBase so can directly concatenate canonicalBase + path

getContentRoot

public PageRef getContentRoot()

Gets the content root for the book.

getCopyright

public Copyright getCopyright()

Gets the copyright for the book or null if none declared. As book copyrights are not inherited, all copyright fields will be non-null.

getAuthors

public Set<Author> getAuthors()

Gets the authors of the book. Any page without more specific authors in itself or a parent (within the book) will use these authors.

getTitle

public String getTitle()

getAllowRobots

public boolean getAllowRobots()

Gets the allowRobots setting of the book. Any page with an "auto" setting and no parents within the book will use this setting.

getParam

public Map<String,String> getParam()