Fork me on GitHub

AO Logo SemanticCMS / Core / Model

Java API for modeling web page content and relationships.

Project Links

Contact Us

For questions or support, please contact us:

Email: support@aoindustries.com
Phone: 1-800-519-9541
Phone: +1-251-607-9556
Web: https://aoindustries.com/contact

Skip navigation links
SemanticCMS Core Model 1.10.0-POST-SNAPSHOT
A B C D E F G H I L M N P S T W 

A

addAuthor(Author) - Method in class com.semanticcms.core.model.Page
 
addChildElement(Element, ElementWriter) - Method in class com.semanticcms.core.model.Element
Adds a child element to this element.
addChildElement(Element, ElementWriter) - Method in class com.semanticcms.core.model.Node
Adds a child element to this node.
addChildRef(ChildRef) - Method in class com.semanticcms.core.model.Page
 
addElement(Element) - Method in class com.semanticcms.core.model.Page
Adds an element to this page.
addPageLink(PageRef) - Method in class com.semanticcms.core.model.Node
 
addParentRef(ParentRef) - Method in class com.semanticcms.core.model.Page
 
appendLabel(Appendable) - Method in class com.semanticcms.core.model.Node
Appends a short description, useful for links and lists, for this node.
appendServletPath(Appendable) - Method in class com.semanticcms.core.model.ElementRef
Appends the combination of the book, the path, and element anchor that refers to the element resource within the web application.
appendServletPath(Appendable) - Method in class com.semanticcms.core.model.PageRef
Appends the combination of the book and the path that refers to the page resource within the web application.
Author - Class in com.semanticcms.core.model
An author of a book, a page, or a set of pages.
Author(String, String, String, String) - Constructor for class com.semanticcms.core.model.Author
Either href may be provided, or book/page may be provided, but not both.

B

Book - Class in com.semanticcms.core.model
A book contains pages and is the central mechanism for high-level separation of content.
Book(String, String, boolean, Set<ParentRef>, Properties) - Constructor for class com.semanticcms.core.model.Book
 

C

checkNotFrozen() - Method in class com.semanticcms.core.model.Node
 
ChildRef - Class in com.semanticcms.core.model
A child reference.
ChildRef(PageRef) - Constructor for class com.semanticcms.core.model.ChildRef
 
close() - Method in class com.semanticcms.core.model.NodeBodyWriter
 
com.semanticcms.core.model - package com.semanticcms.core.model
 
compareTo(Book) - Method in class com.semanticcms.core.model.Book
 
compareTo(PageReferrer) - Method in class com.semanticcms.core.model.ChildRef
Orders by pageRef only.
compareTo(ElementRef) - Method in class com.semanticcms.core.model.ElementRef
Orders by page then id.
compareTo(Page) - Method in class com.semanticcms.core.model.Page
 
compareTo(PageRef) - Method in class com.semanticcms.core.model.PageRef
Orders by servletPath.
compareTo(PageReferrer) - Method in class com.semanticcms.core.model.PageRef
 
compareTo(PageReferrer) - Method in interface com.semanticcms.core.model.PageReferrer
 
compareTo(PageReferrer) - Method in class com.semanticcms.core.model.ParentRef
Orders by pageRef only.
Copyright - Class in com.semanticcms.core.model
The copyright info for a book, a page, or a set of pages.
Copyright(String, String, String) - Constructor for class com.semanticcms.core.model.Copyright
 

D

DEFAULT_TOC_LEVELS - Static variable in class com.semanticcms.core.model.Page
 

E

Element - Class in com.semanticcms.core.model
A page may contain any number of elements (along with arbitrary textual data and other content).
Element() - Constructor for class com.semanticcms.core.model.Element
 
ElementContext - Interface in com.semanticcms.core.model
An element context is able to process includes of other resources during element writing.
ElementRef - Class in com.semanticcms.core.model
An element reference contains a book, a path, and an element id.
ElementRef(PageRef, String) - Constructor for class com.semanticcms.core.model.ElementRef
 
ElementWriter - Interface in com.semanticcms.core.model
Writes an element into the given writer.
equals(Object) - Method in class com.semanticcms.core.model.Author
 
equals(Object) - Method in class com.semanticcms.core.model.Book
 
equals(Object) - Method in class com.semanticcms.core.model.ChildRef
Equality is determined by pageRef only.
equals(Object) - Method in class com.semanticcms.core.model.Copyright
 
equals(Object) - Method in class com.semanticcms.core.model.Element
Two elements are equal when they are the same object or when they are on the same page and have the same ID.
equals(Object) - Method in class com.semanticcms.core.model.ElementRef
 
equals(Object) - Method in class com.semanticcms.core.model.Page
 
equals(Object) - Method in class com.semanticcms.core.model.PageRef
 
equals(Object) - Method in class com.semanticcms.core.model.ParentRef
Equality is determined by pageRef only, short title not a factor.

F

filterElements(Class<E>) - Method in class com.semanticcms.core.model.Page
Gets all elements in the page (including all child elements) that are of the given type, in the order they were declared in the page.
findTopLevelElements(Class<E>) - Method in class com.semanticcms.core.model.Node
Looks for the nearest nested elements of the given class.
flush() - Method in class com.semanticcms.core.model.NodeBodyWriter
 
Freezable<F> - Interface in com.semanticcms.core.model
An object that is freezable begins life as mutable, but once frozen becomes unmodifiable.
freeze() - Method in interface com.semanticcms.core.model.Freezable
 
freeze() - Method in class com.semanticcms.core.model.Node
 
freeze() - Method in class com.semanticcms.core.model.Page
 
frozen - Variable in class com.semanticcms.core.model.Node
 
FrozenException - Exception in com.semanticcms.core.model
Indicates an attempt was made to modify a frozen object.
FrozenException() - Constructor for exception com.semanticcms.core.model.FrozenException
 

G

generateIdPrefix(String, String) - Static method in class com.semanticcms.core.model.Element
getAllowChildMismatch() - Method in class com.semanticcms.core.model.Page
 
getAllowParentMismatch() - Method in class com.semanticcms.core.model.Page
 
getAllowRobots() - Method in class com.semanticcms.core.model.Book
Gets the allowRobots setting of the book.
getAllowRobots() - Method in class com.semanticcms.core.model.Page
Gets the allowRobots setting: null (The default) - Inherit setting from parent(s) within the book or book settings if have no parents within the book true - Robots allowed false - Robots not allowed
getAuthors() - Method in class com.semanticcms.core.model.Book
Gets the authors of the book.
getAuthors() - Method in class com.semanticcms.core.model.Page
 
getBody() - Method in class com.semanticcms.core.model.Node
Every node may potentially have HTML body.
getBook() - Method in class com.semanticcms.core.model.PageRef
the book itself, only available when have access to the referenced book.
getBookName() - Method in class com.semanticcms.core.model.Author
 
getBookName() - Method in class com.semanticcms.core.model.PageRef
The name of the book the page is part of.
getBookPrefix() - Method in class com.semanticcms.core.model.PageRef
The prefix of the book the page is part of.
getCanonicalBase() - Method in class com.semanticcms.core.model.Book
Gets the configured canonicalBase for this book, or null if not configured.
getChildElements() - Method in class com.semanticcms.core.model.Node
Every node may potentially have child elements.
getChildRefs() - Method in class com.semanticcms.core.model.Page
 
getContentRoot() - Method in class com.semanticcms.core.model.Book
Gets the content root for the book.
getCopyright() - Method in class com.semanticcms.core.model.Book
Gets the copyright for the book or null if none declared.
getCopyright() - Method in class com.semanticcms.core.model.Page
 
getCvsworkDirectory() - Method in class com.semanticcms.core.model.Book
 
getDateCopyrighted() - Method in class com.semanticcms.core.model.Copyright
 
getDateCreated() - Method in class com.semanticcms.core.model.Page
getDateModified() - Method in class com.semanticcms.core.model.Page
getDatePublished() - Method in class com.semanticcms.core.model.Page
getDateReviewed() - Method in class com.semanticcms.core.model.Page
This has no equivalent in https://schema.org/, however we feel it is important to actively review content to ensure its accuracy, even when it has not been modified.
getDefaultIdPrefix() - Method in class com.semanticcms.core.model.Element
Gets the default element ID prefix for this type of element.
getDescription() - Method in class com.semanticcms.core.model.Page
 
getElementIdTemplate() - Method in class com.semanticcms.core.model.Element
Gets the element ID template for generating IDs.
getElementRef() - Method in class com.semanticcms.core.model.Element
Gets an ElementRef for this element.
getElements() - Method in class com.semanticcms.core.model.Page
Gets all elements in the page (including all child elements), in the order they were declared in the page.
getElementsById() - Method in class com.semanticcms.core.model.Page
Gets the elements indexed by id, in no particular order.
getGeneratedIds() - Method in class com.semanticcms.core.model.Page
Gets which element IDs were generated.
getHref() - Method in class com.semanticcms.core.model.Author
 
getId() - Method in class com.semanticcms.core.model.Element
When inside a page, every element must have a per-page unique ID, when one is not provided, it will be generated.
getId() - Method in class com.semanticcms.core.model.ElementRef
The id of the element within the page.
getKeywords() - Method in class com.semanticcms.core.model.Page
 
getLabel() - Method in class com.semanticcms.core.model.Node
Gets a short description, useful for links and lists, for this node.
getLabel() - Method in class com.semanticcms.core.model.Page
The page label is its short title.
getName() - Method in class com.semanticcms.core.model.Author
 
getName() - Method in class com.semanticcms.core.model.Book
 
getPage() - Method in class com.semanticcms.core.model.Author
 
getPage() - Method in class com.semanticcms.core.model.Element
Every element may (and usually will) exist within a page.
getPageLinks() - Method in class com.semanticcms.core.model.Node
Gets the set of all pages this node directly links to; this does not include pages linked to by child elements.
getPageRef() - Method in class com.semanticcms.core.model.ChildRef
The reference to the child page.
getPageRef() - Method in class com.semanticcms.core.model.ElementRef
The reference to the page this element is part of.
getPageRef() - Method in class com.semanticcms.core.model.Page
The PageRef that refers to this page.
getPageRef() - Method in class com.semanticcms.core.model.PageRef
A PageRef is its own referrer.
getPageRef() - Method in interface com.semanticcms.core.model.PageReferrer
Gets the page reference.
getPageRef() - Method in class com.semanticcms.core.model.ParentRef
The reference to the parent page.
getParam() - Method in class com.semanticcms.core.model.Book
 
getParentElement() - Method in class com.semanticcms.core.model.Element
Elements may be nested, gets the parent Element above this element.
getParentRefs() - Method in class com.semanticcms.core.model.Book
Gets the parent pages for this book in the context of the current overall content.
getParentRefs() - Method in class com.semanticcms.core.model.Page
 
getPath() - Method in class com.semanticcms.core.model.PageRef
The book-relative path to the page, always starting with a slash (/).
getPathPrefix() - Method in class com.semanticcms.core.model.Book
Gets the path prefix for all pages in this book.
getProperty() - Method in class com.semanticcms.core.model.Node
Gets an unmodifiable snapshot of all properties associated with a node.
getResourceFile(boolean, boolean) - Method in class com.semanticcms.core.model.PageRef
the underlying file, only available when have access to the referenced book
getRights() - Method in class com.semanticcms.core.model.Copyright
 
getRightsHolder() - Method in class com.semanticcms.core.model.Copyright
 
getServletPath() - Method in class com.semanticcms.core.model.ElementRef
Gets the combination of the book, the path, and element anchor that refers to the element resource within the web application.
getServletPath() - Method in class com.semanticcms.core.model.PageRef
Gets the combination of the book and the path that refers to the page resource within the web application.
getShortTitle() - Method in class com.semanticcms.core.model.Page
A short title is used when the context of a page is well established, such as when showing a path to the current location in the site.
getShortTitle() - Method in class com.semanticcms.core.model.ParentRef
A short title is used when the context of a page is well established, such as when showing a path to the current location in the site.
getSrc() - Method in class com.semanticcms.core.model.Page
The PageRef of the editable source for this page, if any.
getTitle() - Method in class com.semanticcms.core.model.Book
 
getTitle() - Method in class com.semanticcms.core.model.Page
 
getToc() - Method in class com.semanticcms.core.model.Page
Gets the table of contents (toc) setting: null (The default) - Show table of contents depending on number of entries in the table true - Always show table of contents false - Never show table of contents TODO: Move this to Section.
getTocLevels() - Method in class com.semanticcms.core.model.Page
TODO: Move this to Section.

H

hasAllFields() - Method in class com.semanticcms.core.model.Copyright
Checks if has all fields (none need inherited).
hashCode() - Method in class com.semanticcms.core.model.Author
 
hashCode() - Method in class com.semanticcms.core.model.Book
 
hashCode() - Method in class com.semanticcms.core.model.ChildRef
Hash is based on pageRef only.
hashCode() - Method in class com.semanticcms.core.model.Copyright
 
hashCode() - Method in class com.semanticcms.core.model.Element
 
hashCode() - Method in class com.semanticcms.core.model.ElementRef
 
hashCode() - Method in class com.semanticcms.core.model.Page
 
hashCode() - Method in class com.semanticcms.core.model.PageRef
 
hashCode() - Method in class com.semanticcms.core.model.ParentRef
Hash is based on pageRef only, short title is not a factor.

I

include(String, Writer, Map<String, ?>) - Method in interface com.semanticcms.core.model.ElementContext
Includes the given resource into the given writer with the provided arguments.
isEmpty() - Method in class com.semanticcms.core.model.Copyright
Checks if the copyright is empty (has all null or blank fields)
isHidden() - Method in class com.semanticcms.core.model.Element
When hidden, an element is not added to common elements like navigation trees.
isValidId(String) - Static method in class com.semanticcms.core.model.Element
Deprecated.

L

lock - Variable in class com.semanticcms.core.model.Node
 

M

MAX_TOC_LEVELS - Static variable in class com.semanticcms.core.model.Page
This matches the table of contents implementation in /semanticcms-section-servlet/toc.inc.jspx and is a result of HTML only having H1 through H6.
MIN_TOC_LEVELS - Static variable in class com.semanticcms.core.model.Page
 

N

Node - Class in com.semanticcms.core.model
A node contains elements, but is not necessarily an element itself.
Node() - Constructor for class com.semanticcms.core.model.Node
 
NodeBodyWriter - Class in com.semanticcms.core.model
Writes node body content, while replacing nested child element markers with child element content.
NodeBodyWriter(Node, Writer, ElementContext) - Constructor for class com.semanticcms.core.model.NodeBodyWriter
 

P

Page - Class in com.semanticcms.core.model
 
Page() - Constructor for class com.semanticcms.core.model.Page
 
PageRef - Class in com.semanticcms.core.model
A page reference contains both a book and a path to a page or directory.
PageRef(String, String) - Constructor for class com.semanticcms.core.model.PageRef
 
PageRef(Book, String) - Constructor for class com.semanticcms.core.model.PageRef
 
PageReferrer - Interface in com.semanticcms.core.model
Something that has a reference to a page.
ParentRef - Class in com.semanticcms.core.model
A parent reference also includes an optional shortTitle for when this page is listed within the context of this specific parent.
ParentRef(PageRef, String) - Constructor for class com.semanticcms.core.model.ParentRef
 

S

setAllowChildMismatch(boolean) - Method in class com.semanticcms.core.model.Page
 
setAllowParentMismatch(boolean) - Method in class com.semanticcms.core.model.Page
 
setAllowRobots(Boolean) - Method in class com.semanticcms.core.model.Page
 
setBody(BufferResult) - Method in class com.semanticcms.core.model.Node
 
setCopyright(Copyright) - Method in class com.semanticcms.core.model.Page
 
setDateCreated(ReadableDateTime) - Method in class com.semanticcms.core.model.Page
 
setDateModified(ReadableDateTime) - Method in class com.semanticcms.core.model.Page
 
setDatePublished(ReadableDateTime) - Method in class com.semanticcms.core.model.Page
 
setDateReviewed(ReadableDateTime) - Method in class com.semanticcms.core.model.Page
 
setDescription(String) - Method in class com.semanticcms.core.model.Page
 
setId(String) - Method in class com.semanticcms.core.model.Element
 
setKeywords(String) - Method in class com.semanticcms.core.model.Page
 
setPageRef(PageRef) - Method in class com.semanticcms.core.model.Page
 
setPath(String) - Method in class com.semanticcms.core.model.PageRef
Sets the path.
setProperty(String, Object) - Method in class com.semanticcms.core.model.Node
Sets a property on this node, if the property has not already been set.
setShortTitle(String) - Method in class com.semanticcms.core.model.Page
 
setSrc(PageRef) - Method in class com.semanticcms.core.model.Page
 
setTitle(String) - Method in class com.semanticcms.core.model.Page
 
setToc(Boolean) - Method in class com.semanticcms.core.model.Page
 
setTocLevels(int) - Method in class com.semanticcms.core.model.Page
 

T

toString() - Method in class com.semanticcms.core.model.Author
 
toString() - Method in class com.semanticcms.core.model.Book
 
toString() - Method in class com.semanticcms.core.model.ChildRef
 
toString() - Method in class com.semanticcms.core.model.Copyright
 
toString() - Method in class com.semanticcms.core.model.ElementRef
 
toString() - Method in class com.semanticcms.core.model.Node
The toString calls Node.getLabel()
toString() - Method in class com.semanticcms.core.model.PageRef
 
toString() - Method in class com.semanticcms.core.model.ParentRef
 

W

write(int) - Method in class com.semanticcms.core.model.NodeBodyWriter
 
write(char[], int, int) - Method in class com.semanticcms.core.model.NodeBodyWriter
 
writeElementMarker(long, Appendable) - Static method in class com.semanticcms.core.model.NodeBodyWriter
 
writeTo(Writer, ElementContext) - Method in interface com.semanticcms.core.model.ElementWriter
Writes the element into the given writer.
A B C D E F G H I L M N P S T W 
Skip navigation links
SemanticCMS Core Model 1.10.0-POST-SNAPSHOT

Copyright © 2013–2019 AO Industries, Inc.. All rights reserved.