/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.ui.search;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.Path;
import org.eclipse.search.ui.text.Match;
import org.teiid.designer.core.ModelerCore;

/**
 * @since 8.0
 */
public class MetadataMatchInfo {

    // ===========================================================================================================================
    // Fields
    // ===========================================================================================================================

    /**
     * The path of this info object's associated resource.
     * 
     * @since 6.0.0
     */
    private final String resourcePath;

    /**
     * The result containing the search result matches.
     * 
     * @since 6.0.0
     */
    private final MetadataSearchResult result;

    // ===========================================================================================================================
    // Constructors
    // ===========================================================================================================================

    /**
     * Constructs an info object with an associated resource at the specified path.
     * 
     * @param resourcePath the path of the resource
     * @param result the search result
     * @since 6.0.0
     */
    public MetadataMatchInfo( String resourcePath,
                              MetadataSearchResult result ) {
        this.resourcePath = resourcePath;
        this.result = result;
    }

    // ===========================================================================================================================
    // Methods
    // ===========================================================================================================================

    /**
     * {@inheritDoc}
     * 
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals( Object obj ) {
        if (obj instanceof MetadataMatchInfo) {
            return getResourcePath().equals(((MetadataMatchInfo)obj).getResourcePath());
        }

        return false;
    }

    /**
     * @return the count of matches for the associated resource
     * @since 6.0.0
     */
    public int getMatchCount() {
        return this.result.getMatchCount(this);
    }
    
    /**
     * @return the matches contained in this info object (never <code>null</code>)
     * @since 6.0.0
     */
    public Match[] getMatches() {
        return this.result.getMatches(this);
    }

    /**
     * @return the associated resource where the matches were found
     * @since 6.0.0
     */
    public IResource getResource() {
        return ModelerCore.getWorkspace().getRoot().getFile(Path.fromOSString(getResourcePath()));
    }

    /**
     * @return the resource path
     * @since 6.0.0
     */
    public String getResourcePath() {
        return this.resourcePath;
    }

    /**
     * {@inheritDoc}
     * 
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return getResourcePath().hashCode();
    }
}