Index (box-core 2.5.2 API)

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(double) - Method in class edu.byu.hbll.box.internal.util.SmoothedAverage: Adds a new value to this statistic.
addDependency(String, String) - Method in class edu.byu.hbll.box.internal.core.Registry: Adds a dependent of a dependency.
addDocument(BoxDocument) - Method in class edu.byu.hbll.box.HarvestResult: Same as add() except returns this.
addDocument(BoxDocument) - Method in class edu.byu.hbll.box.ProcessResult: Same as add() except returns this.
addDocuments(BoxDocument...) - Method in class edu.byu.hbll.box.HarvestResult: Same as addAll() except returns this.
addDocuments(BoxDocument...) - Method in class edu.byu.hbll.box.ProcessResult: Same as addAll() except returns this.
addDocuments(Collection<? extends BoxDocument>) - Method in class edu.byu.hbll.box.HarvestResult: Same as addAll() except returns this.
addDocuments(Collection<? extends BoxDocument>) - Method in class edu.byu.hbll.box.ProcessResult: Same as addAll() except returns this.
addToQueue(QueueEntry...) - Method in class edu.byu.hbll.box.Source: Adds the given entries to this source's process queue.
addToQueue(String...) - Method in class edu.byu.hbll.box.Source: Queues up the given ids to be run against the processor.
addToQueue(String, Instant) - Method in class edu.byu.hbll.box.Source: Queues up the given id to be run against the processor at the given time.
addToQueue(String, Collection<String>, Instant, boolean) - Method in class edu.byu.hbll.box.internal.core.DocumentHandler: Queues up the ids for the given source to be processed in the background.
addToQueue(Duration) - Method in interface edu.byu.hbll.box.BoxDatabase: Used to mark old documents for reprocessing.
addToQueue(Duration) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
addToQueue(Duration) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
addToQueue(Duration, boolean) - Method in interface edu.byu.hbll.box.BoxDatabase: Used to mark old documents for reprocessing.
addToQueue(Collection<? extends QueueEntry>) - Method in interface edu.byu.hbll.box.BoxDatabase: Adds elements to the process queue.
addToQueue(Collection<? extends QueueEntry>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
addToQueue(Collection<? extends QueueEntry>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
addToQueue(Collection<String>) - Method in class edu.byu.hbll.box.Source: Queues up the given ids to be run against the processor.
addToQueue(Collection<String>, Instant) - Method in class edu.byu.hbll.box.Source: Queues up the given ids to be run against the processor at the given time.
addToQueue(Collection<String>, Instant, boolean) - Method in interface edu.byu.hbll.box.BoxDatabase: Deprecated.
use BoxDatabase.addToQueue(Collection) instead if implemented
addToQueue(Collection<String>, Instant, boolean) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
ALL_SOURCES_ALIAS - Static variable in class edu.byu.hbll.box.SourceConfig: For participating operations, this refers to all sources.
awaitOn(long, TimeUnit) - Method in class edu.byu.hbll.box.internal.core.OnOffSemaphore: Blocks until processing is turned back on through setOn(boolean) or until the timeout occurs.

B

baseUri(String) - Method in class edu.byu.hbll.box.impl.View.ViewBuilder: Sets the uri of the underlying remote source upon which the view is built.
baseUri(URI) - Method in class edu.byu.hbll.box.impl.View.ViewBuilder: Sets the uri of the underlying remote source upon which the view is built.
bind(Object) - Method in class edu.byu.hbll.box.ConstructConfig: Binds the params to the target object using Jackson's binding mechanism and rules.
Box - Class in edu.byu.hbll.box: The principal API into the Box system.
BOX_DATABASE - Enum constant in enum class edu.byu.hbll.box.ObjectType: Of type BoxDatabase.
Box.Builder - Class in edu.byu.hbll.box: The configuration used to instantiate Box.
BoxConfigurable - Interface in edu.byu.hbll.box: Any extension classes (ie, classes that implement Processor, Harvester, BoxDatabase, etc) must implement this.
BoxDatabase - Interface in edu.byu.hbll.box: A database to hold processed documents for later retrieval and all other metadata and controls used for processing the documents.
BoxHealth - Class in edu.byu.hbll.box: A snapshot of the health of the Box system.
BoxHealth(boolean, Map<String, SourceHealth>) - Constructor for class edu.byu.hbll.box.BoxHealth: Creates a new BoxHealth initialized with the given health information.
BoxHealthCheck - Class in edu.byu.hbll.box.internal.core: Checks the health of all sources by attempting to query the source.
BoxHealthCheck(Registry) - Constructor for class edu.byu.hbll.box.internal.core.BoxHealthCheck: Creates a new BoxHealthCheck.
build() - Method in class edu.byu.hbll.box.Box.Builder: Builds the new Box instance.
builder() - Static method in class edu.byu.hbll.box.SourceConfig: Returns a builder for SourceConfig.
Builder() - Constructor for class edu.byu.hbll.box.Box.Builder
Builder(String) - Constructor for class edu.byu.hbll.box.SourceConfig.Builder: Deprecated.

Creates a new SourceConfig.Builder.

C

clear() - Method in interface edu.byu.hbll.box.BoxDatabase: Clears the box database for the source.
clear() - Method in class edu.byu.hbll.box.impl.MemoryDatabase
clear() - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
clear() - Method in class edu.byu.hbll.box.Source: Clears the database.
close() - Method in class edu.byu.hbll.box.Box: Closes this Box instance and shutdowns down all internal scheduling and executors.
close() - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor
close() - Method in class edu.byu.hbll.box.internal.core.UpdatesNotifier
collect(BoxQuery) - Method in class edu.byu.hbll.box.Source: Collects and returns all documents found according to the given query.
compare(Number, Number) - Method in class edu.byu.hbll.box.internal.util.NumberComparator
config(JsonNode) - Method in class edu.byu.hbll.box.Box.Builder: Sets all parameters held in the JsonNode.
ConfigParser - Class in edu.byu.hbll.box.internal.core: Parses the yaml box configuration.
ConfigParser() - Constructor for class edu.byu.hbll.box.internal.core.ConfigParser
ConstructConfig - Class in edu.byu.hbll.box: Configuration for initializing newly instantiated Box extension classes.
ConstructConfig() - Constructor for class edu.byu.hbll.box.ConstructConfig: Creates a new empty ConstructConfig.
ConstructConfig(String, ObjectNode) - Constructor for class edu.byu.hbll.box.ConstructConfig: Constructs a new ConstructConfig with the given source name and object params.
count(BoxQuery) - Method in interface edu.byu.hbll.box.BoxDatabase: Returns a count of the number of documents that match the query.
count(BoxQuery) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
count(BoxQuery) - Method in class edu.byu.hbll.box.Source: Returns a count of the number of documents that match the query.
create(String) - Method in class edu.byu.hbll.box.internal.core.DefaultObjectFactory
create(String) - Method in interface edu.byu.hbll.box.ObjectFactory: Creates a new box object according to the implementation.
CURSOR_DATABASE - Enum constant in enum class edu.byu.hbll.box.ObjectType: Of type BoxDatabase used specifically for storing the cursor.

D

DEFAULT_SMOOTHING_FACTOR - Static variable in class edu.byu.hbll.box.internal.util.SmoothedAverage: The default smoothing factor.
DefaultObjectFactory - Class in edu.byu.hbll.box.internal.core: This object factory instantiates a new object of the given class.
DefaultObjectFactory() - Constructor for class edu.byu.hbll.box.internal.core.DefaultObjectFactory
deleteFromQueue(String...) - Method in class edu.byu.hbll.box.Source: Deletes the given ids from the process queue if they exist.
deleteFromQueue(Collection<String>) - Method in interface edu.byu.hbll.box.BoxDatabase: Deletes the given document ids from the queue signifying that the processing of the documents was successful.
deleteFromQueue(Collection<String>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
deleteFromQueue(Collection<String>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
deleteFromQueue(Collection<String>) - Method in class edu.byu.hbll.box.Source: Deletes the given ids from the process queue if they exist.
DocumentHandler - Class in edu.byu.hbll.box.internal.core: Overloaded class for the general handling of documents.
DocumentHandler(Registry) - Constructor for class edu.byu.hbll.box.internal.core.DocumentHandler: Creates a new DocumentHandler.
DocumentProcessor - Class in edu.byu.hbll.box.internal.core: Processes ids using the Processor of the source.
DocumentProcessor(Registry, SourceConfig, QuotaSemaphore) - Constructor for class edu.byu.hbll.box.internal.core.DocumentProcessor: Creates a new DocumentProcessor.

E

edu.byu.hbll.box - package edu.byu.hbll.box
edu.byu.hbll.box.impl - package edu.byu.hbll.box.impl
edu.byu.hbll.box.internal - package edu.byu.hbll.box.internal: Classes inside this package and subpackages are for internal Box purposes.
edu.byu.hbll.box.internal.core - package edu.byu.hbll.box.internal.core
edu.byu.hbll.box.internal.util - package edu.byu.hbll.box.internal.util
endGroup(String) - Method in class edu.byu.hbll.box.HarvestResult: Marks the moment a group finished processing.
endGroup(String) - Method in class edu.byu.hbll.box.ProcessResult: Marks the moment a group finished processing.
EndGroupDocument - Class in edu.byu.hbll.box: Special BoxDocument that signals the end of a group for identifying orphans.
EndGroupDocument(String) - Constructor for class edu.byu.hbll.box.EndGroupDocument: Creates a new EndGroupDocument.

F

facetFields(String, String...) - Method in class edu.byu.hbll.box.SourceConfig.SourceConfigBuilder: Each time a document is saved, fields that match the dot-notated paths will be added as facets with the given name.
facetFields(String, Collection<String>) - Method in class edu.byu.hbll.box.SourceConfig.SourceConfigBuilder: Each time a document is saved, fields that match the dot-notated paths will be added as facets with the given name.
FacetView - Class in edu.byu.hbll.box.impl: A view that translates a facet value into an id and includes all documents with that facet in the final document.
FacetView(AbstractHttpBoxClient, String) - Constructor for class edu.byu.hbll.box.impl.FacetView: Deprecated.
user builder
FacetView(ConstructConfig, InitConfig) - Constructor for class edu.byu.hbll.box.impl.FacetView: Deprecated.
user builder
FacetView.FacetViewBuilder<C extends FacetView,B extends FacetView.FacetViewBuilder<C,B>> - Class in edu.byu.hbll.box.impl: Builder for FacetView.
FacetViewBuilder() - Constructor for class edu.byu.hbll.box.impl.FacetView.FacetViewBuilder
find(BoxQuery) - Method in interface edu.byu.hbll.box.BoxDatabase: Finds documents in the database according to the given query.
find(BoxQuery) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
find(BoxQuery) - Method in class edu.byu.hbll.box.impl.RemoteDatabase
find(BoxQuery) - Method in class edu.byu.hbll.box.impl.View: Finds documents in the database according to the given query.
find(BoxQuery) - Method in class edu.byu.hbll.box.internal.core.MultiView
find(BoxQuery) - Method in class edu.byu.hbll.box.Source: Returns documents found according to the given query in the form of an Iterable.
find(String, BoxQuery) - Method in class edu.byu.hbll.box.internal.core.DocumentHandler: Retrieves documents from the database and returns them.
findDependencies(Collection<String>) - Method in interface edu.byu.hbll.box.BoxDatabase: Finds the dependencies for the given document ids.
findDependencies(Collection<String>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
findDependencies(Collection<String>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
findDependents(Collection<DocumentId>) - Method in interface edu.byu.hbll.box.BoxDatabase: Finds documents dependent on the given dependencies.
findDependents(Collection<DocumentId>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
findDependents(Collection<DocumentId>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
findRegistryValue(String) - Method in interface edu.byu.hbll.box.BoxDatabase: Retrieves a single entry from the registry.
findRegistryValue(String) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
findRegistryValue(String) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
FlexDateParser - Class in edu.byu.hbll.box.internal.util: Flexible date parsing utility class.
FlexDateParser() - Constructor for class edu.byu.hbll.box.internal.util.FlexDateParser
FORMATTER - Static variable in class edu.byu.hbll.box.internal.util.FlexDateParser: The formatter for the flex date parser.

G

get() - Method in class edu.byu.hbll.box.internal.util.SmoothedAverage: Returns the smoothed average.
get(String) - Method in class edu.byu.hbll.box.ProcessBatch: Returns the context for the given id or null if not found.
get(String) - Method in class edu.byu.hbll.box.Source: Retrieves the document for the given id.
get(String...) - Method in class edu.byu.hbll.box.Source: Retrieves the documents for the given ids.
get(Collection<String>) - Method in class edu.byu.hbll.box.Source: Retrieves the documents for the given ids.
getAverageBatchSize() - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Returns the average batch size.
getBoxHealthCheck() - Method in class edu.byu.hbll.box.internal.core.Registry: Returns the box health check.
getConfig() - Method in class edu.byu.hbll.box.Source: Returns the underlying configuration.
getCursor() - Method in class edu.byu.hbll.box.HarvestResult: Returns the cursor to store.
getDependencies() - Method in class edu.byu.hbll.box.ProcessContext: Returns the dependencies.
getDependencies(String) - Method in class edu.byu.hbll.box.ProcessContext: Gets a list of all dependencies for the given source.
getDependency(DocumentId) - Method in class edu.byu.hbll.box.ProcessContext: Returns the dependency matching the given document id or null if none.
getDependency(String, String) - Method in class edu.byu.hbll.box.ProcessContext: Returns the dependency matching the given document id or null if none.
getDependents(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Returns the dependents of the given dependency.
getDocumentHandler() - Method in class edu.byu.hbll.box.internal.core.Registry: Return the document handler.
getDocumentProcessor(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Get the document processor for the given source name.
getFirstContext() - Method in class edu.byu.hbll.box.ProcessBatch: Returns the first found context or null if empty.
getFirstDependency(String) - Method in class edu.byu.hbll.box.ProcessContext: Gets the first dependency for the given source.
getFirstId() - Method in class edu.byu.hbll.box.ProcessBatch: Returns the first id or null if batch is empty.
getHarvestCursor() - Method in interface edu.byu.hbll.box.BoxDatabase: Returns the harvest cursor for this source.
getHarvestCursor() - Method in class edu.byu.hbll.box.impl.MemoryDatabase
getHarvestCursor() - Method in class edu.byu.hbll.box.impl.RemoteDatabase
getHarvestCursor() - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
getHealth() - Method in class edu.byu.hbll.box.Box: Returns a snapshot of the health of the Box system.
getHealth() - Method in class edu.byu.hbll.box.internal.core.BoxHealthCheck: Returns the health of box.
getHealth() - Method in class edu.byu.hbll.box.Source: Returns a snapshot of the health of the Source.
getId() - Method in class edu.byu.hbll.box.ProcessContext: Returns the id to be processed.
getIds() - Method in class edu.byu.hbll.box.ProcessBatch: Returns the ids.
getLocal() - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use getBaseSource
getMessage() - Method in class edu.byu.hbll.box.SourceHealth: Returns a status message (generally null if healthy).
getName() - Method in class edu.byu.hbll.box.Source: Returns the name of this source.
getName() - Method in class edu.byu.hbll.box.SourceConfig.SourceConfigBuilder: Returns the source's name.
getNumBatches() - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Returns the number of batches processed.
getNumDocuments() - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Returns the number of documents processed.
getObjectType() - Method in class edu.byu.hbll.box.ConstructConfig: Returns the object type.
getParams() - Method in class edu.byu.hbll.box.ConstructConfig: Returns the params.
getPreferredCursorDb() - Method in class edu.byu.hbll.box.SourceConfig: Returns cursorDb if not null, otherwise db.
getPrincipalSource() - Method in class edu.byu.hbll.box.Box: Returns the principal source.
getPrincipalSource() - Method in class edu.byu.hbll.box.internal.core.Registry: Returns the principal source config.
getQueue(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Get queue for the given source.
getSource() - Method in class edu.byu.hbll.box.impl.View: Deprecated.
source should be retrieved through the Box instance
getSource(String) - Method in class edu.byu.hbll.box.Box: Returns the registered source denoted by the name.
getSource(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Returns the source config for the given source name.
getSourceHealth(String) - Method in class edu.byu.hbll.box.BoxHealth: Returns the health of the given source.
getSourceHealthMap() - Method in class edu.byu.hbll.box.BoxHealth: Returns the health information for all sources keyed by sourceName.
getSourceName() - Method in class edu.byu.hbll.box.ConstructConfig: Returns the source name.
getSourceName() - Method in class edu.byu.hbll.box.impl.RemoteDatabase: Returns the source name.
getSourceName() - Method in class edu.byu.hbll.box.InitConfig: Returns the source name.
getSourceName() - Method in class edu.byu.hbll.box.SourceHealth: Returns the source name.
getSourceNames() - Method in class edu.byu.hbll.box.Box: Returns a list of names of the registered sources.
getSources() - Method in class edu.byu.hbll.box.Box: Returns a list of the registered sources.
getSources() - Method in class edu.byu.hbll.box.internal.core.Registry: Return the sources.
getStats() - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Prepares a snapshot of timing statistics for the processor.
getThreadFactory() - Method in class edu.byu.hbll.box.internal.core.Registry: Returns the thread factory.
getUpdatesNotifier() - Method in class edu.byu.hbll.box.internal.core.Registry: Returns the updates notifier.
getUri() - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use getBaseUri

H

harvest(HarvestContext) - Method in interface edu.byu.hbll.box.Harvester: Returns the next set or page of documents from the source system.
harvest(HarvestContext) - Method in class edu.byu.hbll.box.impl.View: Returns the next set or page of documents from the source system.
harvest(HarvestContext) - Method in class edu.byu.hbll.box.internal.core.MultiView
HarvestContext - Class in edu.byu.hbll.box: Information for the current harvest.
HarvestContext(ObjectNode) - Constructor for class edu.byu.hbll.box.HarvestContext: Creates a new HarvestContext with the given cursor.
Harvester - Interface in edu.byu.hbll.box: Harvests documents or at least the document ids from a source system.
HARVESTER - Enum constant in enum class edu.byu.hbll.box.ObjectType: Of type Harvester.
HarvestResult - Class in edu.byu.hbll.box: Contains a batch of resulting documents and future harvest information for a given harvest.
HarvestResult() - Constructor for class edu.byu.hbll.box.HarvestResult: Creates an empty HarvestResult.
HarvestResult(Collection<? extends BoxDocument>, ObjectNode, boolean) - Constructor for class edu.byu.hbll.box.HarvestResult: Creates a completely initialized HarvestResult.
hasMore() - Method in class edu.byu.hbll.box.HarvestResult: Returns whether or not there are more documents to harvest.

I

InitConfig - Class in edu.byu.hbll.box: Configuration for initializing newly instantiated Box extension classes.
InitConfig(Box, Source) - Constructor for class edu.byu.hbll.box.InitConfig: Creates a new InitConfig initialized with the given box and source.
isBoxDatabase() - Method in class edu.byu.hbll.box.ConstructConfig: Returns whether or not this is of type database.
isBoxDatabase() - Method in class edu.byu.hbll.box.InitConfig: Returns whether or not this is of type database.
isClosed() - Method in class edu.byu.hbll.box.internal.core.Registry: Returns whether or no the registry is closed.
isConfigured() - Method in class edu.byu.hbll.box.internal.core.Registry: Returns whether or not this registry is configured.
isCursorDatabase() - Method in class edu.byu.hbll.box.ConstructConfig: Returns whether or not this is of type cursor database.
isCursorDatabase() - Method in class edu.byu.hbll.box.InitConfig: Returns whether or not this is of type cursor database.
isHarvester() - Method in class edu.byu.hbll.box.ConstructConfig: Returns whether or not this is of type harvester.
isHarvester() - Method in class edu.byu.hbll.box.InitConfig: Returns whether or not this is of type harvester.
isHealthy() - Method in class edu.byu.hbll.box.BoxHealth: Returns whether this box is healthy.
isHealthy() - Method in class edu.byu.hbll.box.SourceHealth: Returns whether the source is healthy or not.
isOn() - Method in class edu.byu.hbll.box.internal.core.OnOffSemaphore: Returns whether or not processing is on.
isOther() - Method in class edu.byu.hbll.box.ConstructConfig: Returns if type is other.
isOther() - Method in class edu.byu.hbll.box.InitConfig: Returns if type is other.
isPrimary() - Method in class edu.byu.hbll.box.internal.core.PrimaryMonitor: Return whether or not this node is primary.
isPrimary() - Method in class edu.byu.hbll.box.Source: Returns whether or not this node is the primary node in the cluster for this source.
isPrimary(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Whether or not the given source is primary.
isPrincipal() - Method in class edu.byu.hbll.box.Source: Returns whether or not this source is the principal source.
isProcessor() - Method in class edu.byu.hbll.box.ConstructConfig: Returns whether or not this is of type processor.
isProcessor() - Method in class edu.byu.hbll.box.InitConfig: Returns whether or not this is of type processor.
isSource(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Returns true if the given name represents a registered source.

L

listSourceDependencies() - Method in interface edu.byu.hbll.box.BoxDatabase: Finds the unique set of all sources this source is dependent on.
listSourceDependencies() - Method in class edu.byu.hbll.box.impl.MemoryDatabase
listSourceDependencies() - Method in interface edu.byu.hbll.box.ReadOnlyDatabase

M

MemoryDatabase - Class in edu.byu.hbll.box.impl: A box database that holds everything in memory.
MemoryDatabase() - Constructor for class edu.byu.hbll.box.impl.MemoryDatabase
MultiView - Class in edu.byu.hbll.box.internal.core: Experimental.
MultiView() - Constructor for class edu.byu.hbll.box.internal.core.MultiView

N

newBox(JsonNode) - Static method in class edu.byu.hbll.box.Box: Creates a new Box from the supplied configuration.
newBuilder() - Static method in class edu.byu.hbll.box.Box: Creates a new builder.
nextFromQueue(int) - Method in interface edu.byu.hbll.box.BoxDatabase: Return the next batch of ids from the queue.
nextFromQueue(int) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
nextFromQueue(int) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
NumberComparator - Class in edu.byu.hbll.box.internal.util: Compares Numbers numerically.
NumberComparator() - Constructor for class edu.byu.hbll.box.internal.util.NumberComparator

O

objectFactory(ObjectFactory) - Method in class edu.byu.hbll.box.Box.Builder: The factory for creating Box objects such as processor and harvester.
ObjectFactory - Interface in edu.byu.hbll.box: Creates Box objects such as processors and harvesters.
ObjectType - Enum Class in edu.byu.hbll.box: The type of configuration object.
ofIds(List<String>) - Static method in class edu.byu.hbll.box.ProcessBatch: Creates a new ProcessBatch from a list of ids only (ie, no dependency information).
OnOffSemaphore - Class in edu.byu.hbll.box.internal.core: A semaphore to answer whether processing is turned on or not at the moment.
OnOffSemaphore() - Constructor for class edu.byu.hbll.box.internal.core.OnOffSemaphore
OTHER - Enum constant in enum class edu.byu.hbll.box.ObjectType: Any other BoxConfigurable.

P

parse(JsonNode, ObjectFactory) - Static method in class edu.byu.hbll.box.internal.core.ConfigParser: Sets all parameters held in the JsonNode.
parse(String) - Static method in class edu.byu.hbll.box.internal.util.FlexDateParser: Parses an ISO date string into an Instant assuming the system timezone.
parse(String, ZoneId) - Static method in class edu.byu.hbll.box.internal.util.FlexDateParser: Parses an ISO date string into an Instant assuming the given timezone.
postConstruct(ConstructConfig) - Method in interface edu.byu.hbll.box.BoxConfigurable: Called when Box constructs a new instance of the class.
postConstruct(ConstructConfig) - Method in class edu.byu.hbll.box.impl.FacetView
postConstruct(ConstructConfig) - Method in class edu.byu.hbll.box.impl.RemoteDatabase
postConstruct(ConstructConfig) - Method in class edu.byu.hbll.box.impl.View: Called when Box constructs a new instance of the class.
postConstruct(ConstructConfig) - Method in class edu.byu.hbll.box.internal.core.MultiView
postInit(InitConfig) - Method in interface edu.byu.hbll.box.BoxConfigurable: Called after Box is completely initialized.
postInit(InitConfig) - Method in class edu.byu.hbll.box.impl.FacetView
postInit(InitConfig) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
postInit(InitConfig) - Method in class edu.byu.hbll.box.impl.View
postInit(InitConfig) - Method in class edu.byu.hbll.box.internal.core.MultiView
preDestroy() - Method in interface edu.byu.hbll.box.BoxConfigurable: Called when the application is undeployed to allow the client to cleanup resources.
preDestroy() - Method in class edu.byu.hbll.box.internal.core.QueueRunner
preDestroy() - Method in class edu.byu.hbll.box.internal.core.Registry: Shuts down the registry.
PrimaryMonitor - Class in edu.byu.hbll.box.internal.core: In a distributed environment, only one node should be allowed to run harvests.
PrimaryMonitor(BoxDatabase) - Constructor for class edu.byu.hbll.box.internal.core.PrimaryMonitor: Creates a new PrimaryMonitor using the given database for coordination.
PRINCIPAL_SOURCE_ALIAS - Static variable in class edu.byu.hbll.box.internal.core.Registry: Alias for the principal source.
PRINCIPAL_SOURCE_ALIAS - Static variable in class edu.byu.hbll.box.SourceConfig: Always points to the principal source.
process(ProcessBatch) - Method in class edu.byu.hbll.box.impl.View: Processes ids and dependencies associated with the ids into final documents to be saved in the database.
process(ProcessBatch) - Method in class edu.byu.hbll.box.internal.core.MultiView
process(ProcessBatch) - Method in interface edu.byu.hbll.box.Processor: Processes ids and dependencies associated with the ids into final documents to be saved in the database.
process(ProcessBatch) - Method in interface edu.byu.hbll.box.SingleProcessor
process(ProcessContext) - Method in interface edu.byu.hbll.box.SingleProcessor: Processes a single context (ie, no batching).
process(String) - Method in class edu.byu.hbll.box.Source: Processes the given id and returns the document.
process(String...) - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Submits the ids to be processed.
process(String...) - Method in class edu.byu.hbll.box.Source: Processes the given ids and returns the documents.
process(String, Collection<String>) - Method in class edu.byu.hbll.box.internal.core.DocumentHandler: Processes and saves the documents for the given sourceName and ids.
process(Collection<String>) - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Submits the ids to be processed.
process(Collection<String>) - Method in class edu.byu.hbll.box.Source: Processes the given ids and returns the documents.
processAndWait(List<String>) - Method in class edu.byu.hbll.box.internal.core.DocumentProcessor: Processes the ids and waits.
ProcessBatch - Class in edu.byu.hbll.box: A batch of ids/contexts to be processed by a Processor.
ProcessBatch() - Constructor for class edu.byu.hbll.box.ProcessBatch: Creates a new empty ProcessBatch.
ProcessBatch(Collection<? extends ProcessContext>) - Constructor for class edu.byu.hbll.box.ProcessBatch: Creates a new ProcessBatch initialized with the given contexts.
ProcessContext - Class in edu.byu.hbll.box: Contains information about each document to be processed including the ID and required dependencies.
ProcessContext(Box, Source, String, Map<DocumentId, BoxDocument>) - Constructor for class edu.byu.hbll.box.ProcessContext: Creates a new ProcessContext with the given ID and dependencies.
ProcessContext(String) - Constructor for class edu.byu.hbll.box.ProcessContext: Creates a new simple ProcessContext that only specifies which ID to process.
ProcessContext(String, Map<DocumentId, BoxDocument>) - Constructor for class edu.byu.hbll.box.ProcessContext: Creates a new ProcessContext with the given ID and dependencies.
Processor - Interface in edu.byu.hbll.box: Process ids and dependencies associated with the ids into final documents to be saved in the database.
PROCESSOR - Enum constant in enum class edu.byu.hbll.box.ObjectType: Of type Processor.
processOrphans(String, Consumer<BoxDocument>) - Method in interface edu.byu.hbll.box.BoxDatabase: Using the timestamp saved in the database when BoxDatabase.startGroup(String) was called, executes the given function on each document processed before that group start time.
processOrphans(String, Consumer<BoxDocument>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
processOrphans(String, Consumer<BoxDocument>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
ProcessResult - Class in edu.byu.hbll.box: Contains the result of processing a batch of documents.
ProcessResult() - Constructor for class edu.byu.hbll.box.ProcessResult: Creates an empty ProcessResult.
ProcessResult(BoxDocument...) - Constructor for class edu.byu.hbll.box.ProcessResult: Creates a new ProcessResult by adding the initial documents.
ProcessResult(Collection<? extends BoxDocument>) - Constructor for class edu.byu.hbll.box.ProcessResult: Creates a new ProcessResult by adding the initial documents.

Q

QUEUE_PRIORITY_DEFAULT - Static variable in class edu.byu.hbll.box.internal.core.DocumentHandler: Default queue priority.
QUEUE_PRIORITY_MAINTENANCE - Static variable in class edu.byu.hbll.box.internal.core.DocumentHandler: Queue priority for background maintenance tasks.
QueueEntry - Class in edu.byu.hbll.box: An entry to be added to a source's process queue.
QueueEntry(String) - Constructor for class edu.byu.hbll.box.QueueEntry: Creates a new QueueEntry with the given id.
QueueRunner - Class in edu.byu.hbll.box.internal.core: A single background thread that processes tasks from all maintenance queues.
QueueRunner(Registry, SourceConfig, OnOffSemaphore) - Constructor for class edu.byu.hbll.box.internal.core.QueueRunner: Creates a new QueueRunner.
QuotaSemaphore - Class in edu.byu.hbll.box.internal.core: A counting semaphore that represents a quota.
QuotaSemaphore(int) - Constructor for class edu.byu.hbll.box.internal.core.QuotaSemaphore: Creates a new QuotaSemaphore with the given quota count.

R

rawFind(BoxQuery) - Method in class edu.byu.hbll.box.impl.FacetView
rawFind(BoxQuery) - Method in class edu.byu.hbll.box.impl.View: Same as View.find(BoxQuery) except it does not perform any transformation other than applying the preconfigured `fields`, `facets`, and `statuses`.
ReadOnlyDatabase - Interface in edu.byu.hbll.box: Implements all write-methods as no-ops for use as a read-only database.
register(String, Runnable) - Method in class edu.byu.hbll.box.internal.core.UpdatesNotifier: Registers a new updates listener.
registerForUpdateNotifications(Runnable) - Method in class edu.byu.hbll.box.Source: Registers a listener with the updates notification system.
Registry - Class in edu.byu.hbll.box.internal.core: The class holding the keys to box and tying it all together.
Registry(Box, List<SourceConfig>, ThreadFactory) - Constructor for class edu.byu.hbll.box.internal.core.Registry: Creates and initializes the registry given the source configs and thread factory.
REGISTRY_KEY - Static variable in class edu.byu.hbll.box.internal.core.PrimaryMonitor: The field name for this entry in the registry table.
RemoteDatabase - Class in edu.byu.hbll.box.impl: A read only database that pulls all documents from a remote Box using HTTP.
RemoteDatabase() - Constructor for class edu.byu.hbll.box.impl.RemoteDatabase
removeDeleted(Duration) - Method in interface edu.byu.hbll.box.BoxDatabase: Removes all traces of documents that were deleted more than olderThan ago.
removeDeleted(Duration) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
removeDeleted(Duration) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
RESERVED_SOURCE_NAMES - Static variable in class edu.byu.hbll.box.SourceConfig: Reserved source names.
run() - Method in class edu.byu.hbll.box.internal.core.BoxHealthCheck
run() - Method in class edu.byu.hbll.box.internal.core.PrimaryMonitor
run() - Method in class edu.byu.hbll.box.internal.core.QuotaSemaphore: Resets the quota.
run() - Method in class edu.byu.hbll.box.internal.core.UpdatesNotifier

S

save(BoxDocument...) - Method in class edu.byu.hbll.box.Source: Saves the given documents to the database.
save(String, Collection<? extends BoxDocument>) - Method in class edu.byu.hbll.box.internal.core.DocumentHandler: Saves the given documents to the database.
save(Collection<? extends BoxDocument>) - Method in interface edu.byu.hbll.box.BoxDatabase: Save this collection of documents to the database.
save(Collection<? extends BoxDocument>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
save(Collection<? extends BoxDocument>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
save(Collection<? extends BoxDocument>) - Method in class edu.byu.hbll.box.Source: Saves the given documents to the database.
saveRegistryValue(String, JsonNode) - Method in interface edu.byu.hbll.box.BoxDatabase: Saves an entry to the registry denoted by id.
saveRegistryValue(String, JsonNode) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
saveRegistryValue(String, JsonNode) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
setBoxClient(BoxClient) - Method in class edu.byu.hbll.box.impl.View: You should use the builder to set a BoxClient.
setCursor(ObjectNode) - Method in class edu.byu.hbll.box.HarvestResult: Creates a new HarvestResult with the given cursor.
setFacets(Collection<Facet>) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
setFields(Collection<String>) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
setHarvestCursor(ObjectNode) - Method in interface edu.byu.hbll.box.BoxDatabase: Stores this cursor in the database for later retrieval by BoxDatabase.getHarvestCursor().
setHarvestCursor(ObjectNode) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
setHarvestCursor(ObjectNode) - Method in class edu.byu.hbll.box.impl.RemoteDatabase
setHarvestCursor(ObjectNode) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
setHarvestForView(boolean) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
setHarvestUnprocessed(boolean) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
setLimit(long) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
setMore(boolean) - Method in class edu.byu.hbll.box.HarvestResult: Sets more.
setObjectType(ObjectType) - Method in class edu.byu.hbll.box.ConstructConfig: Sets the object type.
setParams(ObjectNode) - Method in class edu.byu.hbll.box.ConstructConfig: Sets the params.
setPriority(double) - Method in class edu.byu.hbll.box.QueueEntry: Sets the priority for the entry.
setSourceName(String) - Method in class edu.byu.hbll.box.ConstructConfig: Sets the source name.
setSourceName(String) - Method in class edu.byu.hbll.box.impl.RemoteDatabase: Sets the source name.
setSourceName(String) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
setStatuses(Collection<BoxDocument.Status>) - Method in class edu.byu.hbll.box.impl.View: Deprecated.
use builder
SingleProcessor - Interface in edu.byu.hbll.box: A Processor that only processes one id/context at a time.
SmoothedAverage - Class in edu.byu.hbll.box.internal.util: Used for statistics.
SmoothedAverage() - Constructor for class edu.byu.hbll.box.internal.util.SmoothedAverage: Creates a new SmoothedAverage with the default smoothing factor.
SmoothedAverage(double) - Constructor for class edu.byu.hbll.box.internal.util.SmoothedAverage: Creates a new SmoothedAverage with the given smoothing factor.
source(Source) - Method in class edu.byu.hbll.box.impl.View.ViewBuilder: Deprecated.
source(SourceConfig) - Method in class edu.byu.hbll.box.Box.Builder: Adds the given source to this configuration.
Source - Class in edu.byu.hbll.box: Main interface into a source.
SourceConfig - Class in edu.byu.hbll.box: The configuration of a source in Box.
SourceConfig() - Constructor for class edu.byu.hbll.box.SourceConfig
SourceConfig.Builder - Class in edu.byu.hbll.box: Deprecated.
Use SourceConfig.builder() instead.
SourceConfig.SourceConfigBuilder - Class in edu.byu.hbll.box: The builder for SourceConfig.
SourceConfigBuilder() - Constructor for class edu.byu.hbll.box.SourceConfig.SourceConfigBuilder
SourceHealth - Class in edu.byu.hbll.box: A snapshot of the health of a particular source.
SourceHealth(String, boolean, String) - Constructor for class edu.byu.hbll.box.SourceHealth: Creates a new SourceHealth.
startGroup(String) - Method in interface edu.byu.hbll.box.BoxDatabase: Marks time in the database that the given group has started.
startGroup(String) - Method in class edu.byu.hbll.box.HarvestResult: Marks the start of a new group to be processed identified by the given groupId.
startGroup(String) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
startGroup(String) - Method in class edu.byu.hbll.box.ProcessResult: Marks the start of a new group to be processed identified by the given groupId.
startGroup(String) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
StartGroupDocument - Class in edu.byu.hbll.box: Special BoxDocument that signals the start of a group for identifying orphans.
StartGroupDocument(String) - Constructor for class edu.byu.hbll.box.StartGroupDocument: Creates a new StartGroupDocument.
startSchedules() - Method in class edu.byu.hbll.box.internal.core.Registry: Starts all the schedulables.
stream(BoxQuery) - Method in class edu.byu.hbll.box.Source: Returns documents found according to the given query in the form of a Stream.
submit(String, Instant, boolean) - Method in class edu.byu.hbll.box.internal.core.QueueRunner: Submits a document ID for future asynchronous processing.

T

threadFactory(ThreadFactory) - Method in class edu.byu.hbll.box.Box.Builder: Sets the thread factory to use for any multithreaded harvesting/processing inside of Box.
toString() - Method in class edu.byu.hbll.box.Source
transform(ProcessBatch) - Method in class edu.byu.hbll.box.impl.View: Extend this class and override this method in order to transform the result documents in any way from the direct processor.
transform(List<BoxDocument>) - Method in class edu.byu.hbll.box.impl.View: Extend this class and override this method in order to transform the result documents in any way from the direct processor.
trigger(String) - Method in class edu.byu.hbll.box.internal.core.UpdatesNotifier: Sets the source that has been updated.
triggerHarvest() - Method in class edu.byu.hbll.box.Source: Triggers the harvester to run.
triggerHarvest(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Triggers a harvest for the given source.
tryAquire(long, TimeUnit) - Method in class edu.byu.hbll.box.internal.core.QuotaSemaphore: Acquires semaphore if quota not reached.

U

unregister(String, Runnable) - Method in class edu.byu.hbll.box.internal.core.UpdatesNotifier: Unregisters an updates listener.
updateDependencies(Collection<? extends BoxDocument>) - Method in interface edu.byu.hbll.box.BoxDatabase: Deprecated.
this is now handled by the save operation
updateDependencies(Collection<? extends BoxDocument>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
updateDependencies(Collection<? extends BoxDocument>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
updateProcessed(Collection<String>) - Method in interface edu.byu.hbll.box.BoxDatabase: Deprecated.
this functionality is now handled in the save operation
updateProcessed(Collection<String>) - Method in class edu.byu.hbll.box.impl.MemoryDatabase
updateProcessed(Collection<String>) - Method in interface edu.byu.hbll.box.ReadOnlyDatabase
UpdatesNotifier - Class in edu.byu.hbll.box.internal.core: Gathers signals that there are updates for sources through UpdatesNotifier.trigger(String).
UpdatesNotifier(ThreadFactory) - Constructor for class edu.byu.hbll.box.internal.core.UpdatesNotifier: Creates a new UpdatesNotifier with the given thread factory.

V

valueOf(String) - Static method in enum class edu.byu.hbll.box.ObjectType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class edu.byu.hbll.box.ObjectType: Returns an array containing the constants of this enum class, in the order they are declared.
verifySource(String) - Method in class edu.byu.hbll.box.Box: Verifies the existence of the source and returns it's name.
verifySource(String) - Method in class edu.byu.hbll.box.internal.core.Registry: Verify this source name and return it if valid.
View - Class in edu.byu.hbll.box.impl: A read-only and realtime view into an internal or external box source.
View(BoxClient) - Constructor for class edu.byu.hbll.box.impl.View: Deprecated.
use builder
View(ConstructConfig, InitConfig) - Constructor for class edu.byu.hbll.box.impl.View: Deprecated.
user builder
View(Source, Source) - Constructor for class edu.byu.hbll.box.impl.View: Deprecated.
use builder
View(URI) - Constructor for class edu.byu.hbll.box.impl.View: Deprecated.
use builder
View.ViewBuilder<C extends View,B extends View.ViewBuilder<C,B>> - Class in edu.byu.hbll.box.impl: Builder for View.
ViewBuilder() - Constructor for class edu.byu.hbll.box.impl.View.ViewBuilder

W

withCursor() - Method in class edu.byu.hbll.box.HarvestResult: Returns the cursor.

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form