nz.net.ultraq.thymeleaf.fragments.FragmentFinder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-layout-dialect Show documentation
Thymeleaf Layout Dialect rewritten in java.
There is a newer version: 3.2.0
Show newest version
/*
 * Copyright 2015, Emanuel Rabina (http://www.ultraq.net.nz/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nz.net.ultraq.thymeleaf.fragments;

import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import nz.net.ultraq.thymeleaf.internal.Extensions;
import org.thymeleaf.model.IModel;
import org.thymeleaf.model.IOpenElementTag;
import org.thymeleaf.model.IProcessableElementTag;
import org.thymeleaf.model.ITemplateEvent;
import org.thymeleaf.util.StringUtils;

/**
 * Searches for and returns layout dialect fragments within a given
 * scope/element.
 *
 * @author zhanhb
 * @author Emanuel Rabina
 */
public class FragmentFinder {

    private final String dialectPrefix;

    /**
     * Constructor, create a new fragment finder to search for fragments using
     * the given prefix as the one configured for the layout dialect.
     *
     * @param dialectPrefix
     */
    public FragmentFinder(String dialectPrefix) {
        this.dialectPrefix = dialectPrefix;
    }

    /**
     * Find and return models for layout dialect fragments within the scope of
     * the given model, without delving into {@code layout:include} or
     * {@code layout:replace} elements, mapped by the name of each fragment.
     *
     * @param model Model whose events are to be searched.
     * @return Map of fragment names and their elements.
     */
    public Map> findFragments(IModel model) {
        Map> fragmentsMap = new LinkedHashMap<>();

        for (int eventIndex = 0, size = model.size(); eventIndex < size;) {
            ITemplateEvent event = model.get(eventIndex);
            if (event instanceof IOpenElementTag) {
                IProcessableElementTag tag = (IProcessableElementTag) event;
                String fragmentName = tag.getAttributeValue(dialectPrefix, FragmentProcessor.PROCESSOR_NAME);
                boolean collect = false;
                if (StringUtils.isEmpty(fragmentName)) {
                    collect = true;
                    fragmentName = tag.getAttributeValue(dialectPrefix, CollectFragmentProcessor.PROCESSOR_DEFINE);
                    if (StringUtils.isEmpty(fragmentName)) {
                        fragmentName = tag.getAttributeValue(dialectPrefix, CollectFragmentProcessor.PROCESSOR_COLLECT);
                    }
                }
                if (!StringUtils.isEmpty(fragmentName)) {
                    IModel fragment = Extensions.getModel(model, eventIndex);
                    List list = fragmentsMap.get(fragmentName);
                    if (list == null) {
                        list = new LinkedList<>();
                        fragmentsMap.put(fragmentName, list);
                    }
                    list.add(fragment);
                    if (!collect) {
                        eventIndex += fragment.size();
                        continue;
                    }
                }
            }
            eventIndex++;
        }

        return fragmentsMap;
    }

}