Package | Description |
---|---|
com.google.enterprise.connector.spi |
Defines the SPI for connector developers who wish to write
plug-ins to the Google Search Appliance.
|
com.google.enterprise.connector.util |
Defines utility classes that might be helpful for connector developers.
|
com.google.enterprise.connector.util.diffing |
The
diffing package provides a framework for writing
connectors to repositories that do not provide information about
added, deleted, or updated documents. |
com.google.enterprise.connector.util.filter |
Document
filters act to transform their source Document's
Properties . |
Modifier and Type | Class and Description |
---|---|
class |
SecureDocument
An implementation of the
Document interface for use with
ACLs. |
class |
SimpleDocument
Simple implementation of the
Document interface. |
class |
SocialUserProfileDocument
A user profile document object.
|
Modifier and Type | Method and Description |
---|---|
Document |
LocalDocumentStore.findDocument(java.lang.String docid)
Deprecated.
Finds a
Document in the Connector Manager's per-document store by
docid. |
Document |
Retriever.getMetaData(java.lang.String docid)
Return a
Document instance populated with meta-data for the
document identified by docid . |
Document |
SimpleDocumentList.nextDocument() |
Document |
DocumentList.nextDocument()
Returns the next
Document in this document list, if there is one. |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Document> |
LocalDocumentStore.getDocumentIterator()
Deprecated.
Returns an iterator of all documents in the store created by this
connector instance, in sorted order by docid.
|
java.util.Iterator<Document> |
LocalDocumentStore.getDocumentIterator(java.lang.String docid)
Deprecated.
Returns an iterator of all documents in the store created by this
connector instance whose docids are
> the specified docid,
in sorted order by docid. |
Modifier and Type | Method and Description |
---|---|
static SecureDocument |
SecureDocument.createDocumentWithAcl(Document document)
Constructs a
SecureDocument representing a document with
an ACL whose metadata consists of the properties of the given
Document . |
static Value |
Value.getSingleValue(Document document,
java.lang.String propertyName)
Convenience function for access to a single named value from a
Document . |
static java.lang.String |
Value.getSingleValueString(Document document,
java.lang.String propertyName)
Convenience function for access to a single string value from a
Document . |
void |
LocalDocumentStore.storeDocument(Document document)
Deprecated.
Persists information about a document.
|
void |
DocumentAcceptor.take(Document document)
Takes an spi Document and pushes it along, presumably to the GSA Feed.
|
Constructor and Description |
---|
SimpleDocumentList(java.util.List<? extends Document> documents)
|
Modifier and Type | Method and Description |
---|---|
Document |
EmptyDocumentList.nextDocument()
Returns the next
Document in this document list, if there is one. |
Modifier and Type | Class and Description |
---|---|
class |
GenericDocument
An generic implementation of
Document . |
Modifier and Type | Method and Description |
---|---|
Document |
DocumentHandle.getDocument()
Returns the non-
null Document for applying this change
to the Google Search Appliance. |
Document |
DeleteDocumentHandle.getDocument() |
Document |
DiffingConnectorDocumentList.nextDocument() |
Modifier and Type | Method and Description |
---|---|
Document |
DocumentFilterFactory.newDocumentFilter(Document source)
Returns a new
Document that acts as a filter for the
supplied source Document. |
Document |
DocumentFilterChain.newDocumentFilter(Document source)
Constructs a document procssing pipeline, assembled from filters fetched
from each of the
DocumentFilterFactories
in the list. |
Document |
AbstractDocumentFilter.newDocumentFilter(Document source) |
Modifier and Type | Method and Description |
---|---|
Property |
SkipDocumentFilter.findProperty(Document source,
java.lang.String name) |
Property |
ModifyPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
DeletePropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
CopyPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
AddPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
AclPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
AbstractDocumentFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
java.util.Set<java.lang.String> |
SkipDocumentFilter.getPropertyNames(Document source) |
java.util.Set<java.lang.String> |
MovePropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , substituting original names of renamed Properties
with the new name. |
java.util.Set<java.lang.String> |
DeletePropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , removing the names of deleted Properties from
the Set returned by the source Document . |
java.util.Set<java.lang.String> |
CopyPropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , including any new Properties that might be
produced by copying other Properties. |
java.util.Set<java.lang.String> |
AddPropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , including any new Properties that might be
added. |
java.util.Set<java.lang.String> |
AbstractDocumentFilter.getPropertyNames(Document source)
|
java.util.List<Value> |
AbstractDocumentFilter.getPropertyValues(Document source,
java.lang.String name)
|
Document |
DocumentFilterFactory.newDocumentFilter(Document source)
Returns a new
Document that acts as a filter for the
supplied source Document. |
Document |
DocumentFilterChain.newDocumentFilter(Document source)
Constructs a document procssing pipeline, assembled from filters fetched
from each of the
DocumentFilterFactories
in the list. |
Document |
AbstractDocumentFilter.newDocumentFilter(Document source) |