StartSubDocument (Okapi Framework SDK 1.44.0 API)

java.lang.Object
- net.sf.okapi.common.resource.BaseNameable
- - net.sf.okapi.common.resource.StartSubDocument

All Implemented Interfaces:

Cloneable, IResource, INameable, IWithAnnotations, IWithProperties, IWithSkeleton
```
public class StartSubDocument
extends BaseNameable
```
Resource associated with the filter event START_SUBDOCUMENT.

Field Summary

Fields
Modifier and Type Field Description

protected String filterId

protected IParameters params
- Fields inherited from class net.sf.okapi.common.resource.BaseNameable
  id, isTranslatable, mimeType, name, preserveWS, type
- Fields inherited from interface net.sf.okapi.common.IResource
  COPY_ALL, COPY_CONTENT, COPY_PROPERTIES, COPY_SEGMENTATION, COPY_SEGMENTED_CONTENT, CREATE_EMPTY

Constructor Summary

Constructors
Constructor Description

StartSubDocument()

StartSubDocument(String parentId)

StartSubDocument(String parentId, String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getFilterId()`	Gets the current filter id for this sub-document.
`IParameters`	`getFilterParameters()`	Gets the current filter parameters for this sub-document.
`String`	`getParentId()`
`void`	`setFilterId(String filterId)`	Sets the filter id for this sub-document.
`void`	`setFilterParameters(IParameters params)`	Sets the filter parameters for this sub-document.
`void`	`setParentId(String parentId)`

Methods inherited from class net.sf.okapi.common.resource.BaseNameable
getAnnotation, getAnnotations, getId, getMimeType, getName, getProperties, getProperty, getPropertyNames, getSkeleton, getType, hasProperty, isTranslatable, preserveWhitespaces, removeProperty, setAnnotation, setId, setIsTranslatable, setMimeType, setName, setPreserveWhitespaces, setProperty, setSkeleton, setType, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.okapi.common.resource.IWithAnnotations
annotationIterator, clear, getAnnotationsTypesAsSet, hasAnnotation, hasAnnotations, remove

Methods inherited from interface net.sf.okapi.common.resource.IWithProperties
propertyIterator

- Field Detail
  - filterId
```
protected String filterId
```
  - params
```
protected IParameters params
```
- Constructor Detail
  - StartSubDocument
```
public StartSubDocument()
```
  - StartSubDocument
```
public StartSubDocument(String parentId)
```
  - StartSubDocument
```
public StartSubDocument(String parentId,
                        String id)
```
- Method Detail
  - getParentId
```
public String getParentId()
```
  - setParentId
```
public void setParentId(String parentId)
```
  - getFilterId
```
public String getFilterId()
```
    Gets the current filter id for this sub-document.
    
    Returns:
    
    the filter id for this document.
  - setFilterId
```
public void setFilterId(String filterId)
```
    Sets the filter id for this sub-document.
    
    Parameters:
    
    filterId - the filter id for this document.
  - getFilterParameters
```
public IParameters getFilterParameters()
```
    Gets the current filter parameters for this sub-document.
    
    Returns:
    
    the object containing the parameters for this document.
  - setFilterParameters
```
public void setFilterParameters(IParameters params)
```
    Sets the filter parameters for this sub-document.
    
    Parameters:
    
    params - the object containing the filter parameters for this document.