MoneyWiseRegionBuilder.java

/*
 * MoneyWise: Finance Application
 * Copyright 2012-2026. Tony Washer
 *
 * 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 io.github.tonywasher.joceanus.moneywise.data.builder;

import io.github.tonywasher.joceanus.oceanus.base.OceanusException;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseDataSet;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseRegion;
import io.github.tonywasher.joceanus.moneywise.exc.MoneyWiseDataException;

/**
 * Region Builder.
 */
public class MoneyWiseRegionBuilder {
    /**
     * DataSet.
     */
    private final MoneyWiseDataSet theDataSet;

    /**
     * The RegionName.
     */
    private String theName;

    /**
     * Constructor.
     *
     * @param pDataSet the dataSet
     */
    public MoneyWiseRegionBuilder(final MoneyWiseDataSet pDataSet) {
        theDataSet = pDataSet;
        theDataSet.getRegions().ensureMap();
    }

    /**
     * Set Name.
     *
     * @param pName the name of the tag.
     * @return the builder
     */
    public MoneyWiseRegionBuilder name(final String pName) {
        theName = pName;
        return this;
    }

    /**
     * Obtain the region.
     *
     * @param pRegion the region.
     * @return the region
     */
    public MoneyWiseRegion lookupRegion(final String pRegion) {
        return theDataSet.getRegions().findItemByName(pRegion);
    }

    /**
     * Build the tag.
     *
     * @return the new tag
     * @throws OceanusException on error
     */
    public MoneyWiseRegion build() throws OceanusException {
        /* Create the region */
        final MoneyWiseRegion myRegion = theDataSet.getRegions().addNewItem();
        myRegion.setName(theName);

        /* Reset the values */
        reset();

        /* Check for errors */
        myRegion.adjustMapForItem();
        myRegion.validate();
        if (myRegion.hasErrors()) {
            myRegion.removeItem();
            throw new MoneyWiseDataException(myRegion, "Failed validation");
        }

        /* Return the region */
        return myRegion;
    }

    /**
     * Reset the builder.
     */
    public void reset() {
        /* Reset values */
        theName = null;
    }
}