A C E F G I L N O P R S T

A

assemble(ContentContext, ContentResource) - Method in class com.endeca.content.assembler.ContentAssembler

Assembles a ContentResource into a ContentItem.

C

com.endeca.content - package com.endeca.content

Contains the core Content Assembler API.

com.endeca.content.assembler - package com.endeca.content.assembler

Contains the core Content Assembler implementation.

com.endeca.content.ene - package com.endeca.content.ene

A Navigation API implementation of the core Content Assembler API.

containsAggregatedRecords() - Method in interface com.endeca.content.ene.RecordListProperty

Indicates whether this property value contains aggregated records.

ContentAssembler - Class in com.endeca.content.assembler

Used to transform a ContentResource into an object model representation of its content item.

ContentAssembler(boolean) - Constructor for class com.endeca.content.assembler.ContentAssembler

Constructs a new ContentAssembler.

ContentContext - Class in com.endeca.content.assembler

Describes the context within which some content assembler operation is occurring.

ContentContext(ContentAssembler, ContentResourceLocator) - Constructor for class com.endeca.content.assembler.ContentContext

Constructs a ContentContext with the given assembler and resource locator.

ContentException - Exception in com.endeca.content

Represents a generic exception when interacting with the Content Assembler API.

ContentException() - Constructor for exception com.endeca.content.ContentException

Constructs a ContentException with no message or cause.

ContentException(String) - Constructor for exception com.endeca.content.ContentException

Constructs a ContentException with the specified message.

ContentException(String, Throwable) - Constructor for exception com.endeca.content.ContentException

Constructs a ContentException with the specified message and cause.

ContentException(Throwable) - Constructor for exception com.endeca.content.ContentException

Constructs a ContentException with the specified cause.

ContentExceptionFactory - Class in com.endeca.content

Provides convenience methods for constructing ContentException instances.

ContentExceptionFactory() - Constructor for class com.endeca.content.ContentExceptionFactory

ContentItem - Interface in com.endeca.content

A single content item from an instance of a ContentResult object.

ContentItemList - Interface in com.endeca.content

A list of content items which includes two additional properties: the type of the items and the maximum number of content items allowed.

ContentManager - Interface in com.endeca.content

A service for creating and managing dynamic content queries.

ContentQuery - Interface in com.endeca.content

An object used for executing content queries.

ContentResource - Interface in com.endeca.content.assembler

Interface for a source of raw content XML.

ContentResourceLocator - Interface in com.endeca.content.assembler

Interface for objects which are capable of locating content.

ContentResults - Interface in com.endeca.content

An object containing the results of an executed ContentQuery.

createQuery() - Method in interface com.endeca.content.ContentManager

Creates an empty ContentQuery.

createQuery() - Method in class com.endeca.content.ene.ENEContentManager

Creates an empty ENEContentQuery.

E

ENEContentManager - Class in com.endeca.content.ene

An implementation of the ContentManager interface.

ENEContentManager() - Constructor for class com.endeca.content.ene.ENEContentManager

Constructs an ENEContentManager.

ENEContentQuery - Class in com.endeca.content.ene

An object used for executing content queries.

ENEContentResults - Class in com.endeca.content.ene

An object containing the results of an executed ContentQuery.

ERecListProperty - Interface in com.endeca.content.ene

Deprecated. since 2.1.0

evaluate(ContentContext, Element) - Method in class com.endeca.content.assembler.ContentAssembler

Finds the appropriate TagHandler, invokes its evaluate method, and returns the result.

evaluate(ContentContext, Element) - Method in interface com.endeca.content.assembler.TagHandler

Evaluates the given XML element and returns the result.

execute() - Method in interface com.endeca.content.ContentQuery

Executes this query and returns content results.

execute() - Method in class com.endeca.content.ene.ENEContentQuery

Executes this query and returns content results.

F

forBadContentContext(ContentContext) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException indicating that the evaluation context was not of the expected type.

forGeneralError(ContentContext, Exception) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException with the given cause.

forGeneralError(ContentResource, Exception) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException with the given cause.

forGeneralError(ContentContext, String) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException with the given error message

forUnexpectedNodeType(ContentContext, short) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException indicating that an unexpected XML node type was encountered.

forUnexpectedTagName(ContentContext, String, String) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException indicating that an unexpected tag name was encountered.

forUnexpectedTagName(ContentContext, String) - Static method in class com.endeca.content.ContentExceptionFactory

Manufactures a ContentException indicating that an unexpected tag name was encountered.

G

getActiveSortKeys() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the sort keys in use for this navigation.

getAggrERecs() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the composite records associated with this navigation query, which come from the original records consolidated by a rollup key.

getAggrERecsOffset() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the offset of the first aggregated record in the aggregated record list with respect to the total number of aggregated records in the dataset that match this navigation query.

getAggrERecsPerPage() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the maximum number of aggregated records that could have been returned from a navigation query.

getContent() - Method in interface com.endeca.content.ContentResults

Returns the root ContentItem for the content query results or null if no content was found.

getContent() - Method in class com.endeca.content.ene.ENEContentResults

Returns the root ContentItem for the content query results or null if no content was found.

getContentAssembler() - Method in class com.endeca.content.assembler.ContentContext

Returns the content assembler being used.

getContentItemStack() - Method in class com.endeca.content.assembler.ContentContext

Returns the stack of ContentItems which are currently being created.

getContentResourceLocator() - Method in class com.endeca.content.assembler.ContentContext

Returns the resource locator being used.

getContentResources() - Method in class com.endeca.content.assembler.ContentContext

Returns a map from the identifiers of the ContentResources which are currently being assembled to the partially-assembled resources themselves.

getContentResourceStack() - Method in class com.endeca.content.assembler.ContentContext

Returns the stack of the ContentResources which are currently being assembled.

getENEConnection() - Method in class com.endeca.content.ene.ENEContentQuery

The ENEConnection to be used when executing this query and any resulting sub-queries.

getENEQuery() - Method in class com.endeca.content.ene.ENEContentQuery

The primary ENEQuery to be used when executing this content query.

getENEQuery() - Method in interface com.endeca.content.ene.RecordListProperty

Returns the query that was used to generate the ERecList value of this property.

getENEQueryResults() - Method in class com.endeca.content.ene.ENEContentResults

Returns the primary ENEQueryResults resulting from the intitial ENEQuery executed by the content assembler.

getENEQueryResults() - Method in interface com.endeca.content.ene.RecordListProperty

Returns the query results that were generated by the ENEQuery of this property.

getERecs() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the records associated with this navigation query.

getERecsOffset() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the offset of the first record in the endeca record list with respect to the total number of records in the dataset that match this navigation query.

getERecsPerPage() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the maximum number of records that could have been returned from a navigation query.

getIdentifier() - Method in interface com.endeca.content.assembler.ContentResource

Returns a unique identifier for this resource.

getLastModified() - Method in interface com.endeca.content.assembler.ContentResource

Returns the date on which this content resource was last modified.

getLocalPropertyName() - Method in class com.endeca.content.assembler.ContentContext

Returns the name of the nearest ancestor property

getMaxContentItems() - Method in interface com.endeca.content.ContentItemList

Returns the maximum number of content items allowed for this list.

getName() - Method in interface com.endeca.content.ContentItem

The name for this content item.

getName() - Method in interface com.endeca.content.Property

Returns the name of this property object.

getProperty(String) - Method in interface com.endeca.content.ContentItem

Returns the Property object associated with the specified key or null if there is no associated Property.

getPropertyList() - Method in interface com.endeca.content.ContentItem

Returns an immutable list of child Property objects.

getPropertyMap() - Method in interface com.endeca.content.ContentItem

Returns an immutable map of child Property objects.

getRollupKeys() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the rollup keys applicable for this navigation.

getRuleZone() - Method in interface com.endeca.content.ContentQuery

The rule zone to be used for resolving dynamic content.

getRuleZone() - Method in class com.endeca.content.ene.ENEContentQuery

The rule zone to be used for resolving dynamic content.

getSortKeys() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the sort keys applicable for this navigation.

getTemplateId() - Method in interface com.endeca.content.ContentItem

The id for the template used to create the content item.

getTemplateType() - Method in interface com.endeca.content.ContentItem

The template type for the content item.

getTotalNumAggrERecs() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the total number of aggregated records matching navigation query.

getTotalNumERecs() - Method in interface com.endeca.content.ene.NavigationRecords

Gets the total number of records matching the navigation query.

getType() - Method in interface com.endeca.content.ContentItemList

Returns the type for the content items in this list.

getValue() - Method in interface com.endeca.content.Property

The value for this property object.

I

InitializationException - Exception in com.endeca.content

Represents an unrecoverable exception while initializing a content assembler -- usually during the construction of a ContentManager.

InitializationException() - Constructor for exception com.endeca.content.InitializationException

Constructs a InitializationException with no message or cause.

InitializationException(String) - Constructor for exception com.endeca.content.InitializationException

Constructs a InitializationException with the specified message.

InitializationException(String, Throwable) - Constructor for exception com.endeca.content.InitializationException

Constructs a InitializationException with the specified message and cause.

InitializationException(Throwable) - Constructor for exception com.endeca.content.InitializationException

Constructs a InitializationException with the specified cause.

InvalidQueryException - Exception in com.endeca.content

Indicates that the specified query is invalid and cannot be executed.

InvalidQueryException() - Constructor for exception com.endeca.content.InvalidQueryException

Constructs a InvalidQueryException with no message or cause.

InvalidQueryException(String) - Constructor for exception com.endeca.content.InvalidQueryException

Constructs a InvalidQueryException with the specified message.

InvalidQueryException(String, Throwable) - Constructor for exception com.endeca.content.InvalidQueryException

Constructs a InvalidQueryException with the specified message and cause.

InvalidQueryException(Throwable) - Constructor for exception com.endeca.content.InvalidQueryException

Constructs a InvalidQueryException with the specified cause.

iterator() - Method in interface com.endeca.content.ContentItem

Returns a sequential iterator of child Property objects.

L

locateContentResources(ContentContext, String) - Method in interface com.endeca.content.assembler.ContentResourceLocator

Finds and returns content resources corresponding to the given zone.

N

NavigationRecords - Interface in com.endeca.content.ene

The Property.getValue() for a Property that was configured to use a NavigationRecords tag.

O

openStream() - Method in interface com.endeca.content.assembler.ContentResource

Returns a stream which may be used to retrieve the content for this resource.

P

Property - Interface in com.endeca.content

A property value contained within a ContentItem object.

R

RecordListProperty - Interface in com.endeca.content.ene

A RecordListProperty property contained within a ContentItem object.

S

setDocumentBuilderFactory(DocumentBuilderFactory) - Method in class com.endeca.content.assembler.ContentAssembler

Overrides the default DocumentBuilderFactory used when parsing content.

setDocumentBuilderFactory(DocumentBuilderFactory) - Method in class com.endeca.content.ene.ENEContentManager

An optional setting to override the default DocumentBuilderFactory used when parsing content.

setENEConnection(ENEConnection) - Method in class com.endeca.content.ene.ENEContentQuery

Specifies the ENEConnection to be used when executing this query and any resulting sub-queries.

setENEQuery(ENEQuery) - Method in class com.endeca.content.ene.ENEContentQuery

Specifies the primary ENEQuery to be used when executing this content query.

setLocalPropertyName(String) - Method in class com.endeca.content.assembler.ContentContext

Sets the name of the nearest ancestor property

setRuleZone(String) - Method in interface com.endeca.content.ContentQuery

Specifies the rule zone to be used for resolving dynamic content.

setRuleZone(String) - Method in class com.endeca.content.ene.ENEContentQuery

Specifies the rule zone to be used for resolving dynamic content.

setValidating(boolean) - Method in class com.endeca.content.assembler.ContentAssembler

Specifies whether XML validation should be enabled when parsing content.

setValidating(boolean) - Method in class com.endeca.content.ene.ENEContentManager

Specifies whether XML validation should be enabled when parsing content.

T

TagHandler - Interface in com.endeca.content.assembler

Interface for ContentAssembler tag handlers.

A C E F G I L N O P R S T