|
ModeShape Distribution 3.2.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.modeshape.jcr.federation.FederatedDocumentReader
public class FederatedDocumentReader
Implementation of a DocumentReader
that be used to obtain "semantic" information from
a federated document
Constructor Summary | |
---|---|
FederatedDocumentReader(DocumentTranslator translator,
Document federatedDocument)
|
Method Summary | |
---|---|
Document |
document()
Returns the underlying document instance. |
Integer |
getCacheTtlSeconds()
Returns the number of seconds that the underlying document should be cached by the repository, if any. |
List<Document> |
getChildren()
Returns the list of children the underlying document has. |
LinkedHashMap<String,Name> |
getChildrenMap()
Returns an ordered map of (childId, childName) the underlying document has. |
String |
getDocumentId()
Returns the id of the underlying document. |
Set<String> |
getMixinTypeNames()
Returns a set with the names of the primary types of the underlying document. |
Set<Name> |
getMixinTypes()
Returns a set with the names of the primary types of the underlying document. |
List<String> |
getParentIds()
Returns the list of identifiers of the parents of the underlying document. |
Name |
getPrimaryType()
Returns name of the primary type of the underlying document. |
String |
getPrimaryTypeName()
Returns the name of primary type of the underlying document. |
Map<Name,Property> |
getProperties()
Returns all the properties of the underlying document. |
Property |
getProperty(Name name)
Returns the property which has the given name, or null if there is no such property. |
Property |
getProperty(String name)
Returns the property which has the given name, or null if there is no such property. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FederatedDocumentReader(DocumentTranslator translator, Document federatedDocument)
Method Detail |
---|
public String getDocumentId()
DocumentReader
getDocumentId
in interface DocumentReader
non-null
String
public List<String> getParentIds()
DocumentReader
getParentIds
in interface DocumentReader
non-null
List
public List<Document> getChildren()
DocumentReader
getChildren
in interface DocumentReader
non-null
List
public LinkedHashMap<String,Name> getChildrenMap()
DocumentReader
The returned map does not contain any explicit same name sibling information, so a connector interested in that would have to do its own, custom processing.
getChildrenMap
in interface DocumentReader
non-null
LinkedHashMap
public Name getPrimaryType()
DocumentReader
getPrimaryType
in interface DocumentReader
non-null
Name
public Set<Name> getMixinTypes()
DocumentReader
getMixinTypes
in interface DocumentReader
non-null
Set
public String getPrimaryTypeName()
DocumentReader
getPrimaryTypeName
in interface DocumentReader
non-null
String
public Set<String> getMixinTypeNames()
DocumentReader
getMixinTypeNames
in interface DocumentReader
non-null
Set
public Map<Name,Property> getProperties()
DocumentReader
getProperties
in interface DocumentReader
non-null
Map
of (property name, property value) pairs.public Property getProperty(Name name)
DocumentReader
getProperty
in interface DocumentReader
name
- a non-null
Name
Property
instance or null
public Property getProperty(String name)
DocumentReader
getProperty
in interface DocumentReader
name
- a non-null
Name
Property
instance or null
public Document document()
DocumentReader
document
in interface DocumentReader
non-null
Document
instance.public Integer getCacheTtlSeconds()
DocumentReader
getCacheTtlSeconds
in interface DocumentReader
Integer
. If null
, it means that there isn't a special requirement for the
underlying document.
|
ModeShape Distribution 3.2.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |