CmsDocumentDependency

java.lang.Object
- org.opencms.search.documents.CmsDocumentDependency

```
public final class CmsDocumentDependency
extends java.lang.Object
```
Provides the dependency information about one search result document, used to generate the list of document search results.

从以下版本开始:

8.5.0

嵌套类概要

嵌套类
限定符和类型类和说明

static class CmsDocumentDependency.DependencyType
Defines the possible dependency types.

嵌套类
限定符和类型	类和说明
`static class`	`CmsDocumentDependency.DependencyType` Defines the possible dependency types.

方法概要

方法
限定符和类型	方法和说明
`void`	`addAttachment(CmsDocumentDependency dep)` Adds another document attachment dependency to this document.
`void`	`addDependency(CmsDocumentDependency dep)` Adds another document dependency to this document.
`void`	`addVariant(CmsDocumentDependency dep)` Adds another language version document dependency to this document.
`boolean`	`equals(java.lang.Object obj)`
`static CmsDocumentDependency`	`fromDependencyString(java.lang.String input, java.lang.String rootPath)` Creates a dependency object from a String representation.
`void`	`fromJSON(JSONObject json, java.lang.String rootPath)` Read the information out of the given JSON object to fill the values of the document.
`int`	`getAttachmentNumber()` Returns the attachment number.
`java.util.List<CmsDocumentDependency>`	`getAttachments()` Returns the attachments.
`java.util.List<CmsDocumentDependency>`	`getDependencies()` Returns the list of resources the main resource depends on, including the main resource itself.
`java.lang.String`	`getDocumentName()` Returns the file name of the document without attachment or locale suffixes.
`java.lang.String`	`getDocumentSuffix()` Returns the suffix of the document.
`java.util.Locale`	`getLocale()` Returns the locale of this document container.
`static java.util.Locale`	`getLocale(java.lang.String rootPath)` Returns the locale (language) of the given resource based on the resource root path.
`CmsDocumentDependency`	`getMainDocument()` Returns the main document in case this document is an attachment.
`CmsPublishedResource`	`getResource()` Returns the VFS resource for which the dependencies are calculated.
`java.lang.String`	`getRootPath()` Returns the root path of this dependency.
`CmsDocumentDependency.DependencyType`	`getType()` Returns the type.
`java.util.List<CmsDocumentDependency>`	`getVariants()` Returns the variants.
`int`	`hashCode()`
`boolean`	`hasLocaleFileName()` Returns the locale file name flag.
`boolean`	`isAttachment()` Returns true if this document is an attachment, i.e. an attachment number is provided.
`static CmsDocumentDependency`	`load(CmsObject cms, CmsPublishedResource pubRes)` Loads or creates a dependency object for the given parameters.
`static CmsDocumentDependency`	`load(CmsObject cms, CmsResource res)` Loads or creates a dependency object for the given parameters.
`static CmsDocumentDependency`	`load(CmsObject cms, CmsResource res, java.util.List<CmsResource> resources)` Loads or creates a dependency object for the given parameters.
`protected static CmsDocumentDependency`	`loadForTest(java.lang.String rootPath)` Creates a dependency object for the given root path, to be used only for test cases.
`void`	`readDependencies(CmsObject cms)` Reads all dependencies that exist for this main resource in the OpenCms VFS.
`void`	`readDependencies(CmsObject cms, java.util.List<CmsResource> folderContent)` Reads all dependencies that exist for this main resource in provided list of resources.
`protected static void`	`removeFromContext(CmsObject cms, CmsPublishedResource pubRes)` Removes the dependency object for a published resource from the OpenCms runtime context.
`void`	`setAttachmentNumber(java.lang.Integer attachmentNumber)` Sets the attachment number.
`void`	`setDocumentName(java.lang.String documentName)` Sets the file name of the document without attachment or locale suffixes.
`void`	`setDocumentSuffix(java.lang.String documentSuffix)` Sets the suffix (.pdf, .doc etc.) of the document.
`void`	`setLocale(java.util.Locale locale)` Sets the locale of this document container.
`void`	`setMainDocument(CmsDocumentDependency mainDocument)` Sets the main document in case this document is an attachment.
`void`	`setType(CmsDocumentDependency.DependencyType type)` Sets the type for this dependency.
`void`	`storeInContext(CmsObject cms)` Stores this dependency object for a published resource in the OpenCms runtime context.
`java.lang.String`	`toDependencyString(CmsObject cms)` Creates the String representation of this dependency object.
`JSONObject`	`toJSON(CmsObject cms, boolean includeLang)` Returns a JSON object describing this dependency document.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - fromDependencyString
```
public static CmsDocumentDependency fromDependencyString(java.lang.String input,
                                         java.lang.String rootPath)
```
    Creates a dependency object from a String representation.
    
    参数:
    input - the String representation
    rootPath - the root path of the base document of which the dependencies are encoded
    
    返回:
    the dependency object created from a String representation
  - getLocale
```
public static java.util.Locale getLocale(java.lang.String rootPath)
```
    Returns the locale (language) of the given resource based on the resource root path.
    
    参数:
    rootPath - the resource name to check for the locale information
    
    返回:
    the locale of the given resource based on the resource root path
  - load
```
public static CmsDocumentDependency load(CmsObject cms,
                         CmsPublishedResource pubRes)
```
    Loads or creates a dependency object for the given parameters.
    
    参数:
    cms - the current OpenCms user context
    pubRes - the published resource to get the dependency object for
    
    返回:
    a dependency object for the given parameters
  - load
```
public static CmsDocumentDependency load(CmsObject cms,
                         CmsResource res)
```
    Loads or creates a dependency object for the given parameters.
    
    参数:
    cms - the current OpenCms user context
    res - the VFS resource to get the dependency object for
    
    返回:
    a dependency object for the given parameters
  - load
```
public static CmsDocumentDependency load(CmsObject cms,
                         CmsResource res,
                         java.util.List<CmsResource> resources)
```
    Loads or creates a dependency object for the given parameters.
    
    参数:
    cms - the current OpenCms user context
    res - the VFS resource to get the dependency object for
    resources - the resource folder data to check for dependencies
    
    返回:
    a dependency object for the given parameters
  - loadForTest
```
protected static CmsDocumentDependency loadForTest(java.lang.String rootPath)
```
    Creates a dependency object for the given root path, to be used only for test cases.
    
    参数:
    rootPath - the root path to create the dependency object for
    
    返回:
    a dependency object for the given parameters
  - removeFromContext
```
protected static void removeFromContext(CmsObject cms,
                     CmsPublishedResource pubRes)
```
    Removes the dependency object for a published resource from the OpenCms runtime context.
    Please note: This must be used with caution since the information may be required to generate documents for several configured indexes. It must be ensured that this is called only when all indexes have been updated.
    
    参数:
    cms - the current OpenCms user context
    pubRes - the published resource info
    另请参阅:
    storeInContext(CmsObject)
  - addAttachment
```
public void addAttachment(CmsDocumentDependency dep)
```
    Adds another document attachment dependency to this document.
    
    参数:
    dep - the document attachment dependency to add
  - addDependency
```
public void addDependency(CmsDocumentDependency dep)
```
    Adds another document dependency to this document.
    
    参数:
    dep - the document dependency to add
  - addVariant
```
public void addVariant(CmsDocumentDependency dep)
```
    Adds another language version document dependency to this document.
    
    参数:
    dep - the language version document dependency to add
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - fromJSON
```
public void fromJSON(JSONObject json,
            java.lang.String rootPath)
```
    Read the information out of the given JSON object to fill the values of the document.
    
    参数:
    json - the JSON object with the information about this document
    rootPath - the current path the home division
  - getAttachmentNumber
```
public int getAttachmentNumber()
```
    Returns the attachment number.
    
    返回:
    the attachment number
  - getAttachments
```
public java.util.List<CmsDocumentDependency> getAttachments()
```
    Returns the attachments.
    
    返回:
    the attachments
  - getDependencies
```
public java.util.List<CmsDocumentDependency> getDependencies()
```
    Returns the list of resources the main resource depends on, including the main resource itself.
    
    返回:
    the list of resources the main resource depends on, including the main resource itself
  - getDocumentName
```
public java.lang.String getDocumentName()
```
    Returns the file name of the document without attachment or locale suffixes.
    
    返回:
    the file name of the document without attachment or locale suffixes
  - getDocumentSuffix
```
public java.lang.String getDocumentSuffix()
```
    Returns the suffix of the document.
    
    返回:
    the suffix of the document
  - getLocale
```
public java.util.Locale getLocale()
```
    Returns the locale of this document container.
    
    返回:
    the locale of this document container
  - getMainDocument
```
public CmsDocumentDependency getMainDocument()
```
    Returns the main document in case this document is an attachment.
    
    返回:
    the main document in case this document is an attachment
  - getResource
```
public CmsPublishedResource getResource()
```
    Returns the VFS resource for which the dependencies are calculated.
    
    返回:
    the VFS resource for which the dependencies are calculated
  - getRootPath
```
public java.lang.String getRootPath()
```
    Returns the root path of this dependency.
    
    返回:
    the root path
  - getType
```
public CmsDocumentDependency.DependencyType getType()
```
    Returns the type.
    
    返回:
    the type
  - getVariants
```
public java.util.List<CmsDocumentDependency> getVariants()
```
    Returns the variants.
    
    返回:
    the variants
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - hasLocaleFileName
```
public boolean hasLocaleFileName()
```
    Returns the locale file name flag.
    
    返回:
    the locale file name flag
  - isAttachment
```
public boolean isAttachment()
```
    Returns true if this document is an attachment, i.e. an attachment number is provided.
    
    返回:
    true if this document is an attachment, otherwise false
  - readDependencies
```
public void readDependencies(CmsObject cms)
```
    Reads all dependencies that exist for this main resource in the OpenCms VFS.
    To be used when incremental updating an index.
    
    参数:
    cms - the current users OpenCms context
  - readDependencies
```
public void readDependencies(CmsObject cms,
                    java.util.List<CmsResource> folderContent)
```
    Reads all dependencies that exist for this main resource in provided list of resources.
    
    参数:
    cms - the current users OpenCms context
    folderContent - the contents of the folder to check the dependencies for
  - setAttachmentNumber
```
public void setAttachmentNumber(java.lang.Integer attachmentNumber)
```
    Sets the attachment number.
    
    参数:
    attachmentNumber - the attachment number
  - setDocumentName
```
public void setDocumentName(java.lang.String documentName)
```
    Sets the file name of the document without attachment or locale suffixes.
    
    参数:
    documentName - the file name of the document without attachment or locale suffixes
  - setDocumentSuffix
```
public void setDocumentSuffix(java.lang.String documentSuffix)
```
    Sets the suffix (.pdf, .doc etc.) of the document.
    
    参数:
    documentSuffix - the suffix to set
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    Sets the locale of this document container.
    
    参数:
    locale - the locale of this document container
  - setMainDocument
```
public void setMainDocument(CmsDocumentDependency mainDocument)
```
    Sets the main document in case this document is an attachment.
    
    参数:
    mainDocument - the main document to set
  - setType
```
public void setType(CmsDocumentDependency.DependencyType type)
```
    Sets the type for this dependency.
    
    参数:
    type - the type to set
  - storeInContext
```
public void storeInContext(CmsObject cms)
```
    Stores this dependency object for a published resource in the OpenCms runtime context.
    This done to optimize indexing speed. When the index update information is calculated, all dependencies for a resource must be calculated also. The same information is later needed when the Lucene document is created, for example in order to store the list of other available languages.
    
    参数:
    cms - the current OpenCms user context
  - toDependencyString
```
public java.lang.String toDependencyString(CmsObject cms)
```
    Creates the String representation of this dependency object.
    
    参数:
    cms - the current OpenCms user context
    
    返回:
    the String representation of this dependency object
  - toJSON
```
public JSONObject toJSON(CmsObject cms,
                boolean includeLang)
```
    Returns a JSON object describing this dependency document.
    
    参数:
    cms - the current cms object
    includeLang - flag if language versions should be included
    
    返回:
    a JSON object describing this dependency document
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()

类 CmsDocumentDependency

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

fromDependencyString

getLocale

load

load

load

loadForTest

removeFromContext

addAttachment

addDependency

addVariant

equals

fromJSON

getAttachmentNumber

getAttachments

getDependencies

getDocumentName

getDocumentSuffix

getLocale

getMainDocument

getResource

getRootPath

getType

getVariants

hashCode

hasLocaleFileName

isAttachment

readDependencies

readDependencies

setAttachmentNumber

setDocumentName

setDocumentSuffix

setLocale

setMainDocument

setType

storeInContext

toDependencyString

toJSON

toString