com.prowidesoftware.swift.model.field

Interface MultiLineField

All Known Implementing Classes:

Field11R, Field11S, Field130, Field134, Field25P, Field26D, Field26K, Field29A, Field29B, Field29D, Field29F, Field29G, Field31B, Field34H, Field35B, Field35E, Field35F, Field35L, Field37N, Field39C, Field40B, Field41A, Field41D, Field42A, Field42C, Field42D, Field42M, Field42P, Field44D, Field45A, Field45B, Field46A, Field46B, Field47A, Field47B, Field48, Field49H, Field49J, Field50, Field50A, Field50B, Field50D, Field50F, Field50G, Field50H, Field50K, Field50M, Field51A, Field51D, Field52A, Field52B, Field52D, Field52G, Field53A, Field53B, Field53D, Field54A, Field54B, Field54D, Field55A, Field55B, Field55D, Field56A, Field56B, Field56D, Field57A, Field57B, Field57D, Field58A, Field58B, Field58D, Field59, Field59A, Field59F, Field61, Field68B, Field68C, Field70, Field70C, Field70D, Field70E, Field70F, Field70G, Field71B, Field71C, Field71D, Field71E, Field72, Field72C, Field73, Field74, Field75, Field76, Field77A, Field77B, Field77C, Field77D, Field77E, Field77F, Field77G, Field77H, Field77J, Field77K, Field77R, Field77S, Field77T, Field78, Field78B, Field79, Field80A, Field80B, Field80C, Field81A, Field81D, Field82A, Field82B, Field82D, Field82S, Field83A, Field83D, Field84A, Field84B, Field84D, Field85A, Field85B, Field85D, Field86, Field86A, Field86B, Field86D, Field87A, Field87B, Field87D, Field87E, Field87F, Field88A, Field88B, Field88D, Field89A, Field89D, Field91A, Field91D, Field94E, Field94G, Field95Q, Field95T, Field95U, Field95V, Field96A, Field96D

public interface MultiLineField

Interface to mark fields whose structure admits multiple lines

Since:

7.7

Author:

www.prowidesoftware.com

Method Summary

Methods

Modifier and Type	Method and Description
String	getLine(int line) Returns a specific line from the field's value.
String	getLine(int line, int offset) Returns a specific line from the field's value. Performs a semantic line retrieval based on the field components definition, so this is not the same as just splitting the value in lines and getting one of the lines with an index. If the field defines the first line components as optional and those components are not present in the particular field instance, then getLine(1) will return null because according to the field definition the first line is not present. Also notice that a line may be composed by several components, there is no linear relation between component numbers and lines numbers. The offset parameter is used to count lines from a specific component instead of the first one, and it is particularly useful when combined with the component static names, for example getLine(1, Field35B.DESCRIPTION) Notice than if the query includes a component offset, the result will not contain prefix component separators.
List<String>	getLines() Returns the field value split into lines.
List<String>	getLines(int offset) Returns the field value starting at the offset component, split into lines.
List<String>	getLinesBetween(int start, int end) Returns a specific subset of lines from the field's value, given a range.
List<String>	getLinesBetween(int start, int end, int offset) Returns a specific subset of lines from the field's value, starting at the offset component.

Method Detail

getLine

String getLine(int line)

Returns a specific line from the field's value.

Parameters:

line - a reference to a specific line in the field, first line being 1

Returns:

line content or null if not present or if line number is above the expected

Since:

7.7

See Also:

getLine(int, int)

getLine

String getLine(int line,
             int offset)

Returns a specific line from the field's value.

Performs a semantic line retrieval based on the field components definition, so this is not the same as just splitting the value in lines and getting one of the lines with an index.
If the field defines the first line components as optional and those components are not present in the particular field instance, then getLine(1) will return null because according to the field definition the first line is not present.
Also notice that a line may be composed by several components, there is no linear relation between component numbers and lines numbers.
The offset parameter is used to count lines from a specific component instead of the first one, and it is particularly useful when combined with the component static names, for example getLine(1, Field35B.DESCRIPTION) Notice than if the query includes a component offset, the result will not contain prefix component separators. If the line for example starts with a slash character it will be removed. This is to avoid meaningless separators for components that are being skipped because of the offset parameter.

Parameters:

line - a reference to a specific line in the field, first line being 1

offset - an optional component number used as offset when counting lines

Returns:

line content or null if not present, if line number is above the expected or if the offset is invalid

Since:

7.7

getLines

List<String> getLines()

Returns the field value split into lines.

Returns:

found lines or empty list if value is empty

Since:

7.7

getLines

List<String> getLines(int offset)

Returns the field value starting at the offset component, split into lines.

Parameters:

offset - an optional component number used as offset when counting lines

Returns:

found lines or empty list if lines are not present or the offset is invalid

Since:

7.7

getLinesBetween

List<String> getLinesBetween(int start,
                           int end)

Returns a specific subset of lines from the field's value, given a range.

Parameters:

start - a reference to a specific line in the field, first line being 1

end - a reference to a specific line in the field, must be greater than start

Returns:

found lines or empty list if value is empty

Since:

7.7

See Also:

getLinesBetween(int, int, int)

getLinesBetween

List<String> getLinesBetween(int start,
                           int end,
                           int offset)

Returns a specific subset of lines from the field's value, starting at the offset component.

Parameters:

start - a reference to a specific line in the field, first line being 1

end - a reference to a specific line in the field, must be greater than start

offset - an optional component number used as offset when counting lines

Returns:

found lines or empty list if lines are not present or the offset is invalid

Since:

7.7