LowCodeSaveOptionsProviderOfAssembling
Inheritance: java.lang.Object, com.aspose.cells.AbstractLowCodeSaveOptionsProvider
public class LowCodeSaveOptionsProviderOfAssembling extends AbstractLowCodeSaveOptionsProvider
Implementation to provide save options which save split parts to files and the path of resultant file are named as(it may contains directories): getPathHeader()+getSheetPrefix()+SheetIndex(or SheetName) +getSplitPartPrefix()+SplitPartIndex+getPathTail().
Constructors
| Constructor | Description |
|---|---|
| LowCodeSaveOptionsProviderOfAssembling() |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| finish(LowCodeSaveOptions part) | Releases resources after processing currently split part. |
| getBuildPathWithSheetAlways() | Whether add sheet index or name to file path always. |
| getBuildPathWithSplitPartAlways() | Whether add split part index to file path always. |
| getClass() | |
| getPathHeader() | Header part(before added content of sheet and split part) of file path. |
| getPathTail() | Tailing part(after sequence numbers) of file path. |
| getSaveOptions(SplitPartInfo part) | Gets the save options from which to get the output settings for currently split part. |
| getSaveOptionsTemplate() | The template for creating instance of save options in AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo). |
| getSheetIndexOffset() | Offset of sheet’s index between what used in file path and its actual value(SplitPartInfo.getSheetIndex()). |
| getSheetPrefix() | Prefix for the index of worksheet. |
| getSplitPartIndexOffset() | Offset of split part’s index between what used in file path and its actual value(SplitPartInfo.getPartIndex()). |
| getSplitPartPrefix() | Prefix for the index of split part. |
| getUseSheetName() | Whether builds the file path with sheet name instead of sheet index. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setBuildPathWithSheetAlways(boolean value) | Whether add sheet index or name to file path always. |
| setBuildPathWithSplitPartAlways(boolean value) | Whether add split part index to file path always. |
| setPathHeader(String value) | Header part(before added content of sheet and split part) of file path. |
| setPathTail(String value) | Tailing part(after sequence numbers) of file path. |
| setSaveOptionsTemplate(LowCodeSaveOptions value) | The template for creating instance of save options in AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo). |
| setSheetIndexOffset(int value) | Offset of sheet’s index between what used in file path and its actual value(SplitPartInfo.getSheetIndex()). |
| setSheetPrefix(String value) | Prefix for the index of worksheet. |
| setSplitPartIndexOffset(int value) | Offset of split part’s index between what used in file path and its actual value(SplitPartInfo.getPartIndex()). |
| setSplitPartPrefix(String value) | Prefix for the index of split part. |
| setUseSheetName(boolean value) | Whether builds the file path with sheet name instead of sheet index. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
LowCodeSaveOptionsProviderOfAssembling()
public LowCodeSaveOptionsProviderOfAssembling()
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
finish(LowCodeSaveOptions part)
public void finish(LowCodeSaveOptions part)
Releases resources after processing currently split part.
Remarks
By default this method just closes the stream specified by the LowCodeSaveOptions.getOutputStream() directly(if the save options specified a Stream as destination). User may overwrite this method to control how to release resources according to their requirement and the implementation of getSaveOptions(SplitPartInfo).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| part | LowCodeSaveOptions | the save options used for currently split part. |
getBuildPathWithSheetAlways()
public boolean getBuildPathWithSheetAlways()
Whether add sheet index or name to file path always. Default value is false, that is, when there is only one sheet, the sheet index(or name) and corresponding prefix will not be added to the file path.
Returns: boolean
getBuildPathWithSplitPartAlways()
public boolean getBuildPathWithSplitPartAlways()
Whether add split part index to file path always. Default value is false, that is, when there is only one split part, the split part index and corresponding prefix will not be added to the file path.
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getPathHeader()
public String getPathHeader()
Header part(before added content of sheet and split part) of file path.
Returns: java.lang.String
getPathTail()
public String getPathTail()
Tailing part(after sequence numbers) of file path. It should include extension of file name.
Returns: java.lang.String
getSaveOptions(SplitPartInfo part)
public LowCodeSaveOptions getSaveOptions(SplitPartInfo part)
Gets the save options from which to get the output settings for currently split part.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| part | SplitPartInfo |
Returns: LowCodeSaveOptions
getSaveOptionsTemplate()
public LowCodeSaveOptions getSaveOptionsTemplate()
The template for creating instance of save options in AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo).
Remarks
If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.
Returns: LowCodeSaveOptions
getSheetIndexOffset()
public int getSheetIndexOffset()
Offset of sheet’s index between what used in file path and its actual value(SplitPartInfo.getSheetIndex()).
Remarks
Only takes effect when getUseSheetName() is false.
Returns: int
getSheetPrefix()
public String getSheetPrefix()
Prefix for the index of worksheet.
Remarks
If there is only one worksheet and getBuildPathWithSheetAlways() is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.
Returns: java.lang.String
getSplitPartIndexOffset()
public int getSplitPartIndexOffset()
Offset of split part’s index between what used in file path and its actual value(SplitPartInfo.getPartIndex()).
Returns: int
getSplitPartPrefix()
public String getSplitPartPrefix()
Prefix for the index of split part.
Remarks
If there is only one split part and getBuildPathWithSplitPartAlways() is false, then this prefix and the split part index(0) will not be added to the resultant file path.
Returns: java.lang.String
getUseSheetName()
public boolean getUseSheetName()
Whether builds the file path with sheet name instead of sheet index. Default value is false.
Remarks
The sheet name will never be rebuilt automatically. So when set it to true, please make sure there is no special sheet name that can cause invalid file path or name.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBuildPathWithSheetAlways(boolean value)
public void setBuildPathWithSheetAlways(boolean value)
Whether add sheet index or name to file path always. Default value is false, that is, when there is only one sheet, the sheet index(or name) and corresponding prefix will not be added to the file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setBuildPathWithSplitPartAlways(boolean value)
public void setBuildPathWithSplitPartAlways(boolean value)
Whether add split part index to file path always. Default value is false, that is, when there is only one split part, the split part index and corresponding prefix will not be added to the file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPathHeader(String value)
public void setPathHeader(String value)
Header part(before added content of sheet and split part) of file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPathTail(String value)
public void setPathTail(String value)
Tailing part(after sequence numbers) of file path. It should include extension of file name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setSaveOptionsTemplate(LowCodeSaveOptions value)
public void setSaveOptionsTemplate(LowCodeSaveOptions value)
The template for creating instance of save options in AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo).
Remarks
If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LowCodeSaveOptions |
setSheetIndexOffset(int value)
public void setSheetIndexOffset(int value)
Offset of sheet’s index between what used in file path and its actual value(SplitPartInfo.getSheetIndex()).
Remarks
Only takes effect when getUseSheetName() is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSheetPrefix(String value)
public void setSheetPrefix(String value)
Prefix for the index of worksheet.
Remarks
If there is only one worksheet and getBuildPathWithSheetAlways() is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setSplitPartIndexOffset(int value)
public void setSplitPartIndexOffset(int value)
Offset of split part’s index between what used in file path and its actual value(SplitPartInfo.getPartIndex()).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSplitPartPrefix(String value)
public void setSplitPartPrefix(String value)
Prefix for the index of split part.
Remarks
If there is only one split part and getBuildPathWithSplitPartAlways() is false, then this prefix and the split part index(0) will not be added to the resultant file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setUseSheetName(boolean value)
public void setUseSheetName(boolean value)
Whether builds the file path with sheet name instead of sheet index. Default value is false.
Remarks
The sheet name will never be rebuilt automatically. So when set it to true, please make sure there is no special sheet name that can cause invalid file path or name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |