A B C D E F G H I K L M O P R S T V W X Z

A

add(ISource) - Method in class com.binaryfantasy.murq.Murq
Adds all content from the specified unencrypted src to this instance.
add(ISource, String) - Method in class com.binaryfantasy.murq.Murq
Adds all content from the specified src to this instance.
add(ISource) - Method in class com.binaryfantasy.murq.MurqSource
 
add(ISource, String) - Method in class com.binaryfantasy.murq.MurqSource
 
add(IContent) - Method in class com.binaryfantasy.murq.search.ContentIndex
Adds indexing information from the provided content to the index, removing and previous index data associated with it.
add(ContentIndex) - Method in class com.binaryfantasy.murq.search.ContentIndex
Adds the index data from the specified index to this ContentIndex.
addClassTerm(Class, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the clazz to this query, checking that content is assignment-compatible.
addContentIdTerm(String, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the contentId to this query, checking that content has the contentId specified.
addContentListener(IContentListener) - Method in class com.binaryfantasy.murq.Murq
Adds a listener to be notified of ContentEvents.
addContentListener(IContentListener, Executor) - Method in class com.binaryfantasy.murq.Murq
Adds a listener to be notified of ContentEvents.
addDateCreatedTerm(Date, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the created to this query, checking that content was created on the created date specified.
addDateModifiedTerm(Date, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the modified to this query, checking that content was modified on the modified date specified.
addKeywordTerm(String, String, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds a keyword value that must be matched exactly, including or excluding the results based on the value of exclude.
addLink(String, String) - Method in class com.binaryfantasy.murq.Murq
Provides a simple name link to the specified contentId.
addLocaleTerm(Locale, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the locale to this query, checking that content is of the locale specified.
addQuery(String, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the queryStr to this query, including or excluding it's results based on the value of exclude.
addQuery(Query, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds the query to this query, including or excluding it's results based on the value of exclude.
addRangedDateCreatedTerm(Date, Date, boolean, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds a creation date range to this query, checking that content was created within the date range specified.
addRangedDateModifiedTerm(Date, Date, boolean, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds a modification date range to this query, checking that content was modified within the date range specified.
addRangedKeywordTerm(String, String, String, boolean, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Adds a keyword value that must fall between the from and to values, including or excluding the results based on the value of exclude.
addSourceListener(ISourceListener) - Method in class com.binaryfantasy.murq.MurqSource
Adds a listener to be notified of SourceEvents.
addSourceListener(ISourceListener, Executor) - Method in class com.binaryfantasy.murq.MurqSource
Adds a listener to be notified of SourceEvents using the specified Executor.
allLocales() - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets this query to ignore locale filtering and return all matching content, even content differing only by locale.

B

BINARY_CONTENT_ID - Static variable in class com.binaryfantasy.murq.Constants
Binary id for binary content.
BinaryContentAdapter - Class in com.binaryfantasy.murq.content
Provides default implementation of the methods described in the IBinaryContent interface.
BinaryContentAdapter() - Constructor for class com.binaryfantasy.murq.content.BinaryContentAdapter
 

C

CLASS_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding content object class names.
CLEAR_ID_PREFIX - Static variable in class com.binaryfantasy.murq.Constants
Prefix indicating that associated content should not be encrypted.
close() - Method in class com.binaryfantasy.murq.Murq
Closes this Murq instance and releases resources.
close() - Method in class com.binaryfantasy.murq.MurqSource
 
close() - Method in class com.binaryfantasy.murq.source.DBSource
 
close() - Method in class com.binaryfantasy.murq.source.FSSource
 
close() - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 
close() - Method in interface com.binaryfantasy.murq.source.ISource
Called when a source is no longer to be used and provides a chance for clean up and release of resources.
close() - Method in class com.binaryfantasy.murq.source.MemorySource
 
close() - Method in class com.binaryfantasy.murq.source.ZipSource
 
com.binaryfantasy.murq - package com.binaryfantasy.murq
 
com.binaryfantasy.murq.content - package com.binaryfantasy.murq.content
 
com.binaryfantasy.murq.event - package com.binaryfantasy.murq.event
 
com.binaryfantasy.murq.search - package com.binaryfantasy.murq.search
 
com.binaryfantasy.murq.source - package com.binaryfantasy.murq.source
 
com.binaryfantasy.murq.source.io - package com.binaryfantasy.murq.source.io
 
com.binaryfantasy.murq.util - package com.binaryfantasy.murq.util
 
compare(IContent, IContent) - Method in class com.binaryfantasy.murq.content.ContentComparator
 
Constants - Class in com.binaryfantasy.murq
Holds static values required throughout Murq.
Constants() - Constructor for class com.binaryfantasy.murq.Constants
 
CONTENT_ID_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding content id.
ContentAdapter - Class in com.binaryfantasy.murq.content
Provides default implementation of the methods described in the IContent interface.
ContentAdapter() - Constructor for class com.binaryfantasy.murq.content.ContentAdapter
 
ContentComparator - Class in com.binaryfantasy.murq.content
Provides a properties based comparator for IContent objects.
ContentComparator(String) - Constructor for class com.binaryfantasy.murq.content.ContentComparator
Construct a comparator that compares based on the single property.
ContentComparator(String[]) - Constructor for class com.binaryfantasy.murq.content.ContentComparator
Construct a comparator that compares based on the properties, with the 0 index having the highest priority and so on.
ContentComparator(String, boolean) - Constructor for class com.binaryfantasy.murq.content.ContentComparator
Construct a comparator that compares based on the single property.
ContentComparator(String[], boolean) - Constructor for class com.binaryfantasy.murq.content.ContentComparator
Construct a comparator that compares based on the properties, with the 0 index having the highest priority and so on.
ContentDirectory - Class in com.binaryfantasy.murq
Tracks SourceKey to ContentId relationships and handles the selection of locale appropriate candidates.
ContentDocument - Class in com.binaryfantasy.murq.search
A utility for converting IContent objects into Lucene Documents for indexing.
ContentEvent - Class in com.binaryfantasy.murq.event
An event indicating that a unit of content has been altered in some way.
ContentEvent(ContentEvent.Type, SourceKey, IContent) - Constructor for class com.binaryfantasy.murq.event.ContentEvent
Constructs a new event.
ContentEvent.Type - Enum in com.binaryfantasy.murq.event
Indicates the type of change that has been performed on a unit of content.
ContentIndex - Class in com.binaryfantasy.murq.search
ContentIndex encapsulates the indexing and searching of content persisted by Murq using Apache Lucene.
ContentIndex(MurqSource) - Constructor for class com.binaryfantasy.murq.search.ContentIndex
Constructs a new ContentIndex object, either from data in the specified src or creating new index data.
create(IContent) - Static method in class com.binaryfantasy.murq.search.ContentDocument
Creates a new Lucene Document representing the content.
create() - Static method in class com.binaryfantasy.murq.search.MurqQuery
Creates and returns a new, unconfigured, MurqQuery.

D

DATE_CREATED_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding the content object creation date.
DATE_MODIFIED_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding the content object last modified date.
DBSource - Class in com.binaryfantasy.murq.source
An ISource implementation that utilizes an RDBMS for persistance.
DBSource(DataSource, String, String, String) - Constructor for class com.binaryfantasy.murq.source.DBSource
Constructs a new instance using the specified dataSource.
DBSource(String, String, String, String, String, String, String) - Constructor for class com.binaryfantasy.murq.source.DBSource
Constructs a new instance using the specified driverClass, url, username and password.
DEFAULT_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding default searchable content text.
defaultProperties() - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
defaultProperties() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
defaultProperties() - Method in interface com.binaryfantasy.murq.search.IIndexable
Returns a Set of properties that should be concatenated together for default searching as a whole.
DiagnosticUtils - Class in com.binaryfantasy.murq.util
Provides methods for creating human readable versions of Murq's internal data structures for diagnostic and logging use.
DiagnosticUtils() - Constructor for class com.binaryfantasy.murq.util.DiagnosticUtils
 
dispatch(IContentListener) - Method in class com.binaryfantasy.murq.event.ContentEvent
 
dispatch(ISourceListener) - Method in class com.binaryfantasy.murq.event.SourceEvent
 

E

equals(Object) - Method in class com.binaryfantasy.murq.source.SourceKey
 

F

finalize() - Method in class com.binaryfantasy.murq.Murq
 
find(MurqQuery) - Method in class com.binaryfantasy.murq.Murq
Performs a search of all content and returns a Set of matching content, or an empty Set if no matches are found.
find(String) - Method in class com.binaryfantasy.murq.Murq
Performs a search of all default content and returns a Set of matching content, or an empty Set if no matches are found.
find(String, Locale) - Method in class com.binaryfantasy.murq.Murq
Performs a search of all content relevant to the provided locale and returns a Set of matching content, or an empty Set if no matches are found.
find(String, Locale, String[]) - Method in class com.binaryfantasy.murq.Murq
Performs a search of all content relevant to the provided locale and returns a Set of matching content, or an empty Set if no matches are found.
find(MurqQuery) - Method in class com.binaryfantasy.murq.search.ContentIndex
Performs a search of all content and returns a Set of matching content, or an empty Set if no matches are found.
find(Query) - Method in class com.binaryfantasy.murq.search.ContentIndex
Performs a search of all content and returns Lucene Hits of matching content.
findAll(String, String[]) - Method in class com.binaryfantasy.murq.Murq
Performs a search of the current contents using the Lucene search engine and returns a Set of ALL matching content objects - regardless of locale, or an empty Set if no matches are found.
findRandom(MurqQuery) - Method in class com.binaryfantasy.murq.Murq
Returns a single, random IContent from the results returned from the specified query, or null if no matches are found.
findRandom(MurqQuery) - Method in class com.binaryfantasy.murq.search.ContentIndex
Returns a single, random IContent from the results returned from the specified query, or null if no matches are found.
findSourceKey(String, Locale) - Method in class com.binaryfantasy.murq.ContentDirectory
Returns the most appropriate SourceKey for the specified contentId and locale using the method described in the java ResourceBundle.getBundle(java.lang.String, java.util.Locale,java.lang.ClassLoader) documentation.
findSourceKeys(MurqQuery) - Method in class com.binaryfantasy.murq.search.ContentIndex
Performs a search of all content and returns a Set of SourceKeys of matching content, or an empty Set if no matches are found.
FSSource - Class in com.binaryfantasy.murq.source
An ISource implementation that utilizes a file system directory as it's data repostiory.
FSSource(String) - Constructor for class com.binaryfantasy.murq.source.FSSource
Constructs a new instance using the specified path.
FSSource(File) - Constructor for class com.binaryfantasy.murq.source.FSSource
Constructs a new instance using the specified directory.

G

get(String) - Method in class com.binaryfantasy.murq.Murq
Returns the default content associated with the specified contentId, or null if no content is found.
get(String, Locale) - Method in class com.binaryfantasy.murq.Murq
Returns the content associated with the specified contentId and relevant to the locale, or null if no content is found.
get(SourceKey) - Method in class com.binaryfantasy.murq.MurqSource
Returns the content associated with the specified key, or null if no content is found.
get(SourceKey) - Method in interface com.binaryfantasy.murq.source.io.ISourceIO
Returns the IContent object associated with the specified key, or null if none is found.
get(SourceKey) - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 
getAll(String, String[]) - Method in class com.binaryfantasy.murq.Murq
Returns a Set of ALL content - regardless of locale - matching the specified contentId, or an empty Set if none are found.
getAllByClass(Class, String[]) - Method in class com.binaryfantasy.murq.Murq
Returns a Set of ALL content that is assignment-compatible with the contentClass and relevant to the locale, or an empty Set if none are found.
getBinaryId() - Method in class com.binaryfantasy.murq.source.SourceKey
Returns the identifier for a piece of binary data belonging to the content holding this key's contentId.
getByClass(Class) - Method in class com.binaryfantasy.murq.Murq
Returns a Set of all default content that is assignment-compatible with the contentClass, or an empty Set if none are found.
getByClass(Class, String[]) - Method in class com.binaryfantasy.murq.Murq
Returns a Set of all default content that is assignment-compatible with the contentClass, or an empty Set if none are found.
getByClass(Class, Locale, String[]) - Method in class com.binaryfantasy.murq.Murq
Returns a Set of content that is assignment-compatible with the contentClass and relevant to the locale, or an empty Set if none are found.
getByteCount() - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
getByteCount() - Method in interface com.binaryfantasy.murq.content.IBinaryContent
Returns the number of bytes in the binary content.
getCandidates(String, Locale) - Static method in class com.binaryfantasy.murq.source.SourceKey
Returns SourceKey local candidates using the method described in ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader).
getComparator() - Method in class com.binaryfantasy.murq.search.MurqQuery
Returns the Comparator to be used for result ordering, or null to use Lucene relavance ordering.
getContent() - Method in class com.binaryfantasy.murq.event.ContentEvent
Returns the affected content, or null if the content itself was not available.
getContentId() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
getContentId() - Method in interface com.binaryfantasy.murq.content.IContent
Returns the unique identifier of this content.
getContentId() - Method in class com.binaryfantasy.murq.source.SourceKey
Returns the base id for this key.
getContentIds() - Method in class com.binaryfantasy.murq.ContentDirectory
Returns a Set of all ContentIds present in the ISource, including protected.
getCreationDate() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
getCreationDate() - Method in interface com.binaryfantasy.murq.content.IContent
Returns the date the content was first persisted, or null if not yet persisted.
getDirectory() - Method in class com.binaryfantasy.murq.MurqSource
 
getFilename() - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
getFilename() - Method in interface com.binaryfantasy.murq.content.IBinaryContent
Returns the original filename of the binary content.
getId() - Method in class com.binaryfantasy.murq.Murq
Returns the unique id belonging to the ISource that backs the Murq facade.
getId() - Method in class com.binaryfantasy.murq.MurqSource
Returns the unique identifier for the raw ISource.
getIndex() - Method in class com.binaryfantasy.murq.MurqSource
 
getInputStream(String) - Method in class com.binaryfantasy.murq.MurqSource
 
getInputStream(String) - Method in class com.binaryfantasy.murq.source.DBSource
 
getInputStream(String) - Method in class com.binaryfantasy.murq.source.FSSource
 
getInputStream(String) - Method in interface com.binaryfantasy.murq.source.ISource
Returns a stream to read the content specified by the key, or null if no content is associated with the key.
getInputStream(String) - Method in class com.binaryfantasy.murq.source.MemorySource
 
getInputStream(String) - Method in class com.binaryfantasy.murq.source.ZipSource
 
getInstance(ISource) - Static method in class com.binaryfantasy.murq.MurqSource
Returns a MurqSource used to interact with the unencrypted source.
getInstance(ISource, String) - Static method in class com.binaryfantasy.murq.MurqSource
Returns a MurqSource used to interact with the source.
getKey() - Method in class com.binaryfantasy.murq.event.SourceEvent
Returns the key of the affected data.
getKeys() - Method in class com.binaryfantasy.murq.MurqSource
 
getKeys() - Method in class com.binaryfantasy.murq.source.DBSource
 
getKeys() - Method in class com.binaryfantasy.murq.source.FSSource
 
getKeys() - Method in interface com.binaryfantasy.murq.source.ISource
Returns a Set of all current keys in this source, or an empty Set if there are none.
getKeys() - Method in class com.binaryfantasy.murq.source.MemorySource
 
getKeys() - Method in class com.binaryfantasy.murq.source.ZipSource
 
getLastModifiedDate() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
getLastModifiedDate() - Method in interface com.binaryfantasy.murq.content.IContent
Returns the date the content was last persisted, or null if not yet persisted.
getLinkNames() - Method in class com.binaryfantasy.murq.Murq
Returns all current link names.
getLinks() - Method in class com.binaryfantasy.murq.MurqSource
Returns the Links used to manage content links for the ISource.
getLocale() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
getLocale() - Method in interface com.binaryfantasy.murq.content.IContent
Returns the locale this content is meant for, or null if default.
getLocale() - Method in class com.binaryfantasy.murq.search.MurqQuery
Returns the Locale for use in localization, or null if default or no localization is to be done.
getLocale() - Method in class com.binaryfantasy.murq.source.SourceKey
Returns this key's specific locale, or null if it represents default content.
getLocales(IContent) - Method in class com.binaryfantasy.murq.Murq
Returns all Locales that the specified content is available in.
getLocales(String) - Method in class com.binaryfantasy.murq.Murq
Returns all Locales that the specified contentId is available in.
getLock() - Method in class com.binaryfantasy.murq.MurqSource
 
getMurqSource() - Method in interface com.binaryfantasy.murq.source.io.ISourceIO
Returns the MurqSource this instance is handling IO for.
getMurqSource() - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 
getOutputStream(String) - Method in class com.binaryfantasy.murq.MurqSource
 
getOutputStream(String) - Method in class com.binaryfantasy.murq.source.DBSource
 
getOutputStream(String) - Method in class com.binaryfantasy.murq.source.FSSource
 
getOutputStream(String) - Method in interface com.binaryfantasy.murq.source.ISource
Returns a stream to write the content associated with the key.
getOutputStream(String) - Method in class com.binaryfantasy.murq.source.MemorySource
 
getOutputStream(String) - Method in class com.binaryfantasy.murq.source.ZipSource
 
getQuery() - Method in class com.binaryfantasy.murq.search.MurqQuery
Returns the Lucene Query resulting from this object's configuration.
getSource() - Method in class com.binaryfantasy.murq.Murq
Returns the ISource being used for persistance.
getSourceIO() - Method in class com.binaryfantasy.murq.MurqSource
 
getSourceKey() - Method in class com.binaryfantasy.murq.event.ContentEvent
Returns the SourceKey of the affected content.
getSourceKey(String) - Static method in class com.binaryfantasy.murq.source.SourceKey
Returns a SourceKey represented by the specified String.
getSourceKey(IContent) - Static method in class com.binaryfantasy.murq.source.SourceKey
Returns a SourceKey represented by the specified IContent.
getSourceKey(String, Locale, String) - Static method in class com.binaryfantasy.murq.source.SourceKey
Returns a SourceKey representing the contentId and the optional locale and binaryId.
getSourceKeys() - Method in class com.binaryfantasy.murq.ContentDirectory
Returns a Set of all SourceKeys present in the ISource, including protected.
getSourceKeys(String) - Method in class com.binaryfantasy.murq.ContentDirectory
Returns a Set of all SourceKeys related to the specified contentId.
getType() - Method in class com.binaryfantasy.murq.event.ContentEvent
Returns the type of event.
getType() - Method in class com.binaryfantasy.murq.event.SourceEvent
Returns the type of event.

H

hashCode() - Method in class com.binaryfantasy.murq.source.SourceKey
 

I

IBinaryContent - Interface in com.binaryfantasy.murq.content
Defines content used to describe associated binary content.
IContent - Interface in com.binaryfantasy.murq.content
Defines the essential properties of content to be persisted.
IContentListener - Interface in com.binaryfantasy.murq.event
A listening interface for receiving ContentEvents.
ID_KEY - Static variable in class com.binaryfantasy.murq.Constants
ContentId holding the unique id of a given ISource.
IIndexable - Interface in com.binaryfantasy.murq.search
Implementers of IIndexable declare the bean type properties they want made available for searching.
init(MurqSource) - Method in interface com.binaryfantasy.murq.source.io.ISourceIO
First call made after instantiation allowing for any setup that my be needed.
init(MurqSource) - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 
InvalidPasswordException - Exception in com.binaryfantasy.murq
Thrown when an invalid password is provided to access an ISource.
InvalidPasswordException(ISource) - Constructor for exception com.binaryfantasy.murq.InvalidPasswordException
Constructs a new exception with a message specifying the ISource that was trying to be accessed.
IO_KEY - Static variable in class com.binaryfantasy.murq.Constants
ContentId pointing to the ISourceIO implementation used for serialization on a given ISource.
isBinary() - Method in class com.binaryfantasy.murq.source.SourceKey
Return true if this key points to binary data.
isLocalized() - Method in class com.binaryfantasy.murq.search.MurqQuery
Return true if results will be localized.
isOpen() - Method in class com.binaryfantasy.murq.Murq
Returns true if this Murq instance is open.
ISource - Interface in com.binaryfantasy.murq.source
A ISource is any type of persistant storage that can have content in binary format streamed into it and associated with a unique key, then stream the same binary content back from the same key.
ISourceIO - Interface in com.binaryfantasy.murq.source.io
Implementors translate IContent objects to and from streams in an ISource.
ISourceListener - Interface in com.binaryfantasy.murq.event
A listening interface for receiving SourceEvents.
isUpdating() - Method in class com.binaryfantasy.murq.Murq
Returns true if there are ContentEvents being processed.

K

keywordProperties() - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
keywordProperties() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
keywordProperties() - Method in interface com.binaryfantasy.murq.search.IIndexable
Returns a Set of properties that are not tokenized, but are indexed.

L

LINK_NAME_VALUE_SEPARATOR - Static variable in class com.binaryfantasy.murq.Constants
Delimiter used to separate a link name from it's value in link data content.
LINK_SEPARATOR - Static variable in class com.binaryfantasy.murq.Constants
Delimiter used to separate links in the link data content.
LINKS_KEY - Static variable in class com.binaryfantasy.murq.Constants
ContentId pointing to link data in a given ISource.
locale(Locale) - Method in class com.binaryfantasy.murq.search.MurqQuery
Set the Locale that results should be appropriate for, based on the method outlined in the ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) method.
LOCALE_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding content object locale.
localize() - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets this query filter content for locale appropriateness, based on the method outlined in the ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) method.

M

MemorySource - Class in com.binaryfantasy.murq.source
A ISource implementation intended for testing purposes only.
MemorySource() - Constructor for class com.binaryfantasy.murq.source.MemorySource
Default constructor.
Murq - Class in com.binaryfantasy.murq
The face of the Murq persistance library.
Murq(ISource) - Constructor for class com.binaryfantasy.murq.Murq
Constructs a new instance using the specified source.
Murq(ISource, String) - Constructor for class com.binaryfantasy.murq.Murq
Constructs a new instance using the specified source.
MurqQuery - Class in com.binaryfantasy.murq.search
A MurqQuery represents critera for content to be returned from Murq.
MurqSource - Class in com.binaryfantasy.murq
An ISource wrapper that manages the raw interaction with the persistance layer.

O

onContentEvent(ContentEvent) - Method in interface com.binaryfantasy.murq.event.IContentListener
Called when a ContentEvent is fired.
onSourceEvent(SourceEvent) - Method in class com.binaryfantasy.murq.ContentDirectory
 
onSourceEvent(SourceEvent) - Method in interface com.binaryfantasy.murq.event.ISourceListener
Called when a SourceEvent is fired.
orderBy(Comparator<IContent>) - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets the Comparator to be used to order results.
orderBy(String[], boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets the priority of properties to be compared when ordering results.
orderBy(String, boolean) - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets the property to be compared when ordering results.
orderBy(String[]) - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets the priority of properties to be compared when ordering results.
orderBy(String) - Method in class com.binaryfantasy.murq.search.MurqQuery
Sets the property to be compared when ordering results.

P

PASSWORD_KEY - Static variable in class com.binaryfantasy.murq.Constants
ContentId pointing to the MD5 hash of the password for a given ISource.
PROTECTED_ID_PREFIX - Static variable in class com.binaryfantasy.murq.Constants
ContentId prefix indicating that the associated content should not be returned by Murq, but is instead for internal use only.
put(IContent) - Method in class com.binaryfantasy.murq.Murq
Persists the specified content.
put(IContent, boolean) - Method in class com.binaryfantasy.murq.Murq
Persists the specified content, ignoring any possible concurrent modification issues if force is true.
put(IContent, boolean, boolean) - Method in class com.binaryfantasy.murq.MurqSource
Persists the specified content, ignoring any possible concurrent modification issues if force is true.
put(IContent) - Method in interface com.binaryfantasy.murq.source.io.ISourceIO
Writes the provided content.
put(IContent) - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 

R

read(String, OutputStream) - Method in class com.binaryfantasy.murq.Murq
Reads the default binary data associated with the contentId and writes it to the specified out.
read(String, Locale, OutputStream) - Method in class com.binaryfantasy.murq.Murq
Reads binary data relevant to the locale and associated with the contentId, writing it to the specified out.
read(SourceKey, OutputStream) - Method in class com.binaryfantasy.murq.MurqSource
Reads the default binary data associated with the key and writes it to the specified out.
remove(IContent) - Method in class com.binaryfantasy.murq.Murq
Removes the specified content.
remove(String, Locale) - Method in class com.binaryfantasy.murq.Murq
Removes the specified content.
remove(SourceKey) - Method in class com.binaryfantasy.murq.MurqSource
Removes the content specified by the key.
remove(String) - Method in class com.binaryfantasy.murq.MurqSource
 
remove(SourceKey) - Method in class com.binaryfantasy.murq.search.ContentIndex
Removes index data about the content associated with the specified key.
remove(String) - Method in class com.binaryfantasy.murq.source.DBSource
 
remove(String) - Method in class com.binaryfantasy.murq.source.FSSource
 
remove(SourceKey) - Method in interface com.binaryfantasy.murq.source.io.ISourceIO
Returns true if the content associated with the specified key is removed, false if the key is not found.
remove(SourceKey) - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 
remove(String) - Method in interface com.binaryfantasy.murq.source.ISource
Returns true if the content mapped to the provided key was removed, false if no content is associated with the key.
remove(String) - Method in class com.binaryfantasy.murq.source.MemorySource
 
remove(String) - Method in class com.binaryfantasy.murq.source.ZipSource
 
removeAll(String) - Method in class com.binaryfantasy.murq.Murq
Removes all content, in all locales, associated with the specified contentId.
removeContentListener(IContentListener) - Method in class com.binaryfantasy.murq.Murq
Removes a listener from being notified of ContentEvents.
removeLink(String) - Method in class com.binaryfantasy.murq.Murq
Removes a simple name link.
removeLinks(String) - Method in class com.binaryfantasy.murq.Murq
Removes all links associated with the contentId.
removeSourceListener(ISourceListener) - Method in class com.binaryfantasy.murq.MurqSource
Removes a listener from being notified of SourceEvents.
resolveLink(String, Locale) - Method in class com.binaryfantasy.murq.Murq
Returns the IContent relevant to the locale targeted by the specified linkName, or null if none exists.
resolveLinkId(String) - Method in class com.binaryfantasy.murq.Murq
Returns the contentId relevant to the specified linkName, or null if none exists.
resovleLink(String) - Method in class com.binaryfantasy.murq.Murq
Returns the default IContent target of the specified linkName, or null if none exists.

S

SEPARATOR_BINARY - Static variable in class com.binaryfantasy.murq.source.SourceKey
Character used to separate the optional binary id from the content id and/or the locale.
SEPARATOR_LOCALE - Static variable in class com.binaryfantasy.murq.source.SourceKey
Character used to separate locale from content id.
setByteCount(long) - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
setByteCount(long) - Method in interface com.binaryfantasy.murq.content.IBinaryContent
Sets the number of bytes in the binary content.
setContentId(String) - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
setContentId(String) - Method in interface com.binaryfantasy.murq.content.IContent
Sets the unique identifier of this content.
setCreationDate(Date) - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
setCreationDate(Date) - Method in interface com.binaryfantasy.murq.content.IContent
Sets the date the content was first persisted.
setFilename(String) - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
setFilename(String) - Method in interface com.binaryfantasy.murq.content.IBinaryContent
Sets the original filename of the binary content.
setLastModifiedDate(Date) - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
setLastModifiedDate(Date) - Method in interface com.binaryfantasy.murq.content.IContent
Sets the date the content was last persisted.
setLocale(Locale) - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
setLocale(Locale) - Method in interface com.binaryfantasy.murq.content.IContent
Sets the locale this content is meant for.
SOURCE_KEY_FIELD - Static variable in class com.binaryfantasy.murq.search.ContentDocument
The index field holding source keys.
SourceEvent - Class in com.binaryfantasy.murq.event
An event indicating that an ISource has been altered in some way.
SourceEvent(SourceEvent.Type, String) - Constructor for class com.binaryfantasy.murq.event.SourceEvent
Constructs a new event.
SourceEvent.Type - Enum in com.binaryfantasy.murq.event
Indicates the type of change that has been performed on a ISource.
SourceException - Exception in com.binaryfantasy.murq.source
Thrown when a ISource throws an exception that is not expected.
SourceException(String, Throwable) - Constructor for exception com.binaryfantasy.murq.source.SourceException
 
SourceException(String) - Constructor for exception com.binaryfantasy.murq.source.SourceException
 
SourceKey - Class in com.binaryfantasy.murq.source
An immutable internal class that manages the translation between content's public id, locale and possibly it's internal binary id and it's String source key.

T

textProperties() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
textProperties() - Method in interface com.binaryfantasy.murq.search.IIndexable
Returns a Set of properties that are tokenized and indexed.
toString() - Method in class com.binaryfantasy.murq.content.BinaryContentAdapter
 
toString() - Method in class com.binaryfantasy.murq.content.ContentAdapter
 
toString() - Method in class com.binaryfantasy.murq.ContentDirectory
 
toString() - Method in class com.binaryfantasy.murq.event.ContentEvent
 
toString() - Method in class com.binaryfantasy.murq.event.SourceEvent
 
toString() - Method in class com.binaryfantasy.murq.Murq
 
toString() - Method in class com.binaryfantasy.murq.source.FSSource
 
toString() - Method in class com.binaryfantasy.murq.source.io.XStreamSourceIO
 
toString() - Method in class com.binaryfantasy.murq.source.MemorySource
 
toString() - Method in class com.binaryfantasy.murq.source.SourceKey
 
toString() - Method in class com.binaryfantasy.murq.source.ZipSource
 
toString(ISource) - Static method in class com.binaryfantasy.murq.util.DiagnosticUtils
Returns a text rendering of the contents of the specified ISource.
toString(ISource, String) - Static method in class com.binaryfantasy.murq.util.DiagnosticUtils
Returns a text rendering of the specified content in the ISource.
toString(Directory) - Static method in class com.binaryfantasy.murq.util.DiagnosticUtils
Returns a text rendering of the contents of the specified Lucene Directory.

V

valueOf(String) - Static method in enum com.binaryfantasy.murq.event.ContentEvent.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.binaryfantasy.murq.event.SourceEvent.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.binaryfantasy.murq.event.ContentEvent.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.binaryfantasy.murq.event.SourceEvent.Type
Returns an array containing the constants of this enum type, in the order they're declared.
VERIFICATION_KEY - Static variable in class com.binaryfantasy.murq.Constants
ContentId pointing to the encrypted clear text password for a given ISource.

W

write(IBinaryContent, InputStream) - Method in class com.binaryfantasy.murq.Murq
Persists the specified binary data from the in along with the metadata describing it in the content.
write(IBinaryContent, InputStream, boolean) - Method in class com.binaryfantasy.murq.Murq
Persists the specified binary data from the in along with the metadata describing it in the content, ignoring any possible concurrent modification issues if force is true.
write(IBinaryContent, InputStream, boolean, boolean) - Method in class com.binaryfantasy.murq.MurqSource
Persists the specified binary data from the in along with the metadata describing it in the content, ignoring any possible concurrent modification issues if force is true.

X

XStreamSourceIO - Class in com.binaryfantasy.murq.source.io
Translates IContent objects to and from streams in an ISource using XStream.
XStreamSourceIO() - Constructor for class com.binaryfantasy.murq.source.io.XStreamSourceIO
Constructs a new XStreamSourceIO to handle IContent object translation using XStream encoding.

Z

ZipSource - Class in com.binaryfantasy.murq.source
An ISource implementation that utilizes a zip file as it's data repository.
ZipSource(String) - Constructor for class com.binaryfantasy.murq.source.ZipSource
Constructs a new instance using the specified path.
ZipSource(File) - Constructor for class com.binaryfantasy.murq.source.ZipSource
Constructs a new instance using the specified zip.

A B C D E F G H I K L M O P R S T V W X Z

Copyright (c) 2000-2006, BinaryFantasy.com