Package com._1c.g5.v8.dt.dcs.dataset.fields

Class DataSetsFieldsWrapperField

java.lang.Object

com._1c.g5.v8.dt.dcs.dataset.fields.DataSetsFieldsWrapperBase<DataCompositionSchemaDataSetField>

com._1c.g5.v8.dt.dcs.dataset.fields.DataSetsFieldsWrapperField

All Implemented Interfaces:

IDataSetFieldsWrapper, Comparable<IDataSetFieldsWrapper>

public class DataSetsFieldsWrapperField
extends DataSetsFieldsWrapperBase<DataCompositionSchemaDataSetField>

Wrapper for data set field

Nested Class Summary

Nested classes/interfaces inherited from interface com._1c.g5.v8.dt.dcs.dataset.fields.IDataSetFieldsWrapper

IDataSetFieldsWrapper.FieldCommand, IDataSetFieldsWrapper.FieldRenameException

Field Summary

Fields inherited from class com._1c.g5.v8.dt.dcs.dataset.fields.DataSetsFieldsWrapperBase

dataSetWrapper, field

Constructor Summary

Constructors

Constructor	Description
DataSetsFieldsWrapperField(IDataSetWrapper dataSetWrapper, DataCompositionSchemaDataSetField field)	Constructor

Method Summary

Modifier and Type	Method	Description
IDataSetFieldsWrapper.FieldCommand	copy(String parentPath, String name)	Copy field
String	getName()	Get name (field in viewer)
String	getPath()	Get data path
Presentation	getTitle()	Get title
boolean	isTitleAuto()	Check whether title is autogenerated
IDataSetFieldsWrapper.FieldCommand	remove()	Remove field
IDataSetFieldsWrapper.FieldCommand	setName(String name, boolean checkUnique)	Set name (field in viewer)
IDataSetFieldsWrapper.FieldCommand	setPath(String pathNew, boolean checkUnique)	Set data path
IDataSetFieldsWrapper.FieldCommand	setTitle(Presentation title)	Set title

Methods inherited from class com._1c.g5.v8.dt.dcs.dataset.fields.DataSetsFieldsWrapperBase

compareTo, getCurrentLanguageCode, getDuplicatedErrorMessage, getField, getFieldByPath, getFieldsWrappers, getParentPath, getPathFromString, getSynonym, getTitle, isFolder, isNameUnique, isPathUnique, isStringEquals, setTitle, setTitle, startsWith, throwError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DataSetsFieldsWrapperField

public DataSetsFieldsWrapperField(IDataSetWrapper dataSetWrapper,
 DataCompositionSchemaDataSetField field)

Constructor

Parameters:

dataSetWrapper - data set wrapper, can't be null

field - field, can't be null

Method Details

getName

public String getName()

Description copied from interface: IDataSetFieldsWrapper

Get name (field in viewer)

Returns:

name, never null, empty for folder

setName

public IDataSetFieldsWrapper.FieldCommand setName(String name,
 boolean checkUnique)
                                           throws IDataSetFieldsWrapper.FieldRenameException

Description copied from interface: IDataSetFieldsWrapper

Set name (field in viewer)

Parameters:

name - name, can't be null

checkUnique - check whether name is unique

Returns:

command, never null

Throws:

IDataSetFieldsWrapper.FieldRenameException - if checkUnique true and name is not unique

getPath

public String getPath()

Description copied from interface: IDataSetFieldsWrapper

Get data path

Returns:

path, never null

setPath

public IDataSetFieldsWrapper.FieldCommand setPath(String pathNew,
 boolean checkUnique)
                                           throws IDataSetFieldsWrapper.FieldRenameException

Description copied from interface: IDataSetFieldsWrapper

Set data path

Parameters:

pathNew - path, can't be null

checkUnique - check whether path is unique

Returns:

command, never null

Throws:

IDataSetFieldsWrapper.FieldRenameException - if checkUnique true and path is not unique

isTitleAuto

public boolean isTitleAuto()

Description copied from interface: IDataSetFieldsWrapper

Check whether title is autogenerated

Returns:

whether title is autogenerated

getTitle

public Presentation getTitle()

Description copied from interface: IDataSetFieldsWrapper

Get title

Returns:

title, never null

setTitle

public IDataSetFieldsWrapper.FieldCommand setTitle(Presentation title)

Description copied from interface: IDataSetFieldsWrapper

Set title

Parameters:

title - title, can't be null

Returns:

command, never null

copy

public IDataSetFieldsWrapper.FieldCommand copy(String parentPath,
 String name)

Description copied from interface: IDataSetFieldsWrapper

Copy field

Parameters:

parentPath - parent path for copy, can't be null

name - name for copy, can't be null

Returns:

command, never null

remove

public IDataSetFieldsWrapper.FieldCommand remove()
                                          throws IDataSetFieldsWrapper.FieldRenameException

Description copied from interface: IDataSetFieldsWrapper

Remove field

Returns:

command, never null

Throws:

IDataSetFieldsWrapper.FieldRenameException - if after removing name of some child field won't be unique