How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Wed, 18 Jul 2018 07:37:29 GMT

Current Revision posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 7/18/2018 7:37:29 AM

In this documentation we assume you are familiar with Batch Task plugin structure and with Visitor Pattern. More information about Visitor Pattern can be found here.

Like in previous documentation we'll also use Project Anonymizer plugin for code example. Full source code of the project can be found here . SegmentVisitor.cs class contains the algorithm which recursive searches for words inside a segment and does all the logic for replacing the data.

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Each segment you see in Studio editor programmatically is in fact List<IAbstractMarkupData> . For example if in one segment you have plain text and placeholder tag the list will have one IText object and an IPlaceholderTag both interfaces inherits IAbstractMarkupData.

Because the objects you see above are interfaces we don't have access to them out of the box. This is why need to use Visitor Pattern which will loop through all the elements and if the element is a placeholder, the method VisitPlaceholderTag() will be called automatically. If the element is a text VisitText() method will be called automatically.

Bellow you can see how you have access to text property for am IText object.

How to create a Placeholder tag using public API

gist.github.com/.../20623f7f0f1461a9ccfe9de5636037e6

We assume that we want to transform the IText object from VisitText() into a placeholder. We take the text from the object, create a new placeholder using the method above. All good but what we achieved until now is to create a new placeholder which is not added to the sdlxliff.

The tag we created must be inserted in the List<IAbstractMarkupData> on the exactly the same position where the IText is.

How replace the IText with IPlaceholder tag

Each object you receive in visitor patterns methods belongs to a "Parent", which is a IAbstractMarkupDataContainer. What we need to to:

take the parent container: var elementContainer = text.Parent;
from the parent container we need to take all the subitems : text.Parent.AllSubItems.ToList()
remove the element at specified position: elementContainer.AllSubItems.ToList()[postion].RemoveFromParent();
insert the tag in the position we removed the text : elementContainer.Insert(position, tag);

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 11:10:37 GMT

Revision 12 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 11:10:37 AM

In this documentation we assume you are familiar with Batch Task plugin structure and with Visitor Pattern. More information about Visitor Pattern can be found here.

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Bellow you can see how you have access to text property for am IText object.

How to create a Placeholder tag using public API

var tag = IDocumentItemFactory.CreatePlaceholderTag(
IPropertiesFactory.CreatePlaceholderTagProperties("text which should be displayed"));
tag.Properties.SetMetaData("customKey", "customValue"); how to set custom metadata on your tag

The tag we created must be inserted in the List<IAbstractMarkupData> on the exactly the same position where the IText is.

How replace the IText with IPlaceholder tag

Each object you receive in visitor patterns methods belongs to a "Parent", which is a IAbstractMarkupDataContainer. What we need to to:

take the parent container: var elementContainer = text.Parent;
from the parent container we need to take all the subitems : text.Parent.AllSubItems.ToList()
remove the element at specified position: elementContainer.AllSubItems.ToList()[postion].RemoveFromParent();
insert the tag in the position we removed the text : elementContainer.Insert(position, tag);

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 11:05:10 GMT

Revision 11 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 11:05:10 AM

In this documentation we assume you are familiar with Batch Task plugin structure and with Visitor Pattern. More information about Visitor Pattern can be found here. Like in previous documentation we'll also use Project Anonymizer plugin for code example. Full source code of the project can be found here . SegmentVisitor.cs class contains the algorithm which recursive searches for words inside a segment. And does all the logic for replacing the data.

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Each segment you see in Studio editor programmatically is in fact List<IAbstractMarkupData> . For example if in one segment you have plain text and placeholder tag. The list will have one IText object and an IPlaceholderTag both interfaces inherits IAbstractMarkupData.

Because the objects you see above are interfaces we don't have access to them out of the box. Because of that we need to use Visitor Pattern which will loop through all the elements and if the element is a placeholder, the method VisitPlaceholderTag() will be called automatically. If the element is a text VisitText() method will be called automatically.

Bellow you can see how you have access to text property for am IText object.

How to create a Placeholder tag using public API

We assume that we want to transform the IText object from VisitText() into a placeholder. We take the text of the object, create a new placeholder using the method above. All good but what we achieve until now is to create a new placeholder which is not added to the sdlxliff.

The tag we created must be inserted in the List<IAbstractMarkupData> on the exactly the same position where the IText is. That means we need to find the index of the IText object, remove it from list, and in his place we need to add the tag item we created above.

How replace the IText with IPlaceholder tag

Each object you receive in visitor patterns methods belongs to a "Parent", which is a IAbstractMarkupDataContainer. What we need to to:

take the parent container: var elementContainer = text.Parent;
from the parent container we need to take all the subitems : text.Parent.AllSubItems.ToList()
remove the element at specified position: elementContainer.AllSubItems.ToList()[postion].RemoveFromParent();
insert the tag in the position we removed the text : elementContainer.Insert(position, tag);

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 10:50:34 GMT

Revision 10 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 10:50:34 AM

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Bellow you can see how you have access to text property for am IText object.

How to create a Placeholder tag using public API

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 10:42:31 GMT

Revision 9 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 10:42:31 AM

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Bellow you can see how you have access to text property for am IText object.

How to create a Placeholder tag using public API

var tag = IDocumentItemFactory.CreatePlaceholderTag(
IPropertiesFactory.CreatePlaceholderTagProperties("text which should be displayed"));
tag.Properties.SetMetaData("Anonymizer", "Anonymizer"); how to set custom metadata on your tag

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 10:36:09 GMT

Revision 8 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 10:36:09 AM

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Bellow you can see how you have access to text property for am IText object.

For example if we want to transform "December" which currently is IText object we need to implement Visitor Pattern

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 10:21:48 GMT

Revision 7 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 10:21:48 AM

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Brief API's concepts explications

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 10:05:34 GMT

Revision 6 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 10:05:34 AM

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Dependencies

If you don't have referenced Sdl.FileTypeSupport.Framework.BilingualApi.dll and Sdl.FileTypeSupport.Framework.NativeApi.dll please add a reference to them.

From Sdl.FileTypeSupport.Framework.BilingualApi.dll we'll use IDocumentItemFactory interface.

From Sdl.FileTypeSupport.Framework.NativeApi.dll we'll use IPropertiesFactory interface. This two interfaces will allow is to create a placeholder object.

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 10:00:13 GMT

Revision 5 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 10:00:13 AM

What we want to achieve

Search in a segment for a particular text and transform that text in a placeholder. In our source code we use regular expressions find matches in segment text.

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 09:53:15 GMT

Revision 4 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 9:53:15 AM

In this documentation we assume you are familiar with Batch Task plugin structure, and with Visitor Pattern. More information about Visitor pattern can be found here. Like in previous documentation we'll also use Project Anonymizer plugin for code example. Full source code of the project can be found here .

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 09:52:00 GMT

Revision 3 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 9:52:00 AM

In this documentation we assume you are familiar with Batch Task plugin structure, and with Visitor Pattern . Like in previous documentation we'll also use Project Anonymizer plugin for code example. Full source code of the project can be found here .

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment in Batch Task context

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 09:34:13 GMT

Revision 2 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 9:34:13 AM

Tags: batch task, Studio Documentation, Studio API, openexchange

How to insert a placeholder in Segment

Andrea-Melinda Ghisa — Mon, 30 Apr 2018 08:42:32 GMT

Revision 1 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/30/2018 8:42:32 AM

Tags: batch task, Studio Documentation, Studio API, openexchange